Skip to content

Commit

Permalink
chore(readme): adjust readme to the project and remove old one
Browse files Browse the repository at this point in the history
  • Loading branch information
kostyatarasenko committed Jun 20, 2024
1 parent a805816 commit b926054
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 9 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,30 @@
# Getting Started with Create React App
# Getting Started with Freelancer Earn Tracker App

This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).

## About

A simple service to keep track of a freelancer's income. Main project stack: React, Typescript, AWS Amplify.

## Demo

Coming soon...

## Available Scripts

In the project directory, you can run:

### `npm start`

Runs the app in the development mode.\
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
Open [http://localhost:8080](http://localhost:8080) to view it in the browser.

The page will reload if you make edits.\
You will also see any lint errors in the console.

### `npm test`

Launches the test runner in the interactive watch mode.\
Launches the test runner.\
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.

### `npm run build`
Expand All @@ -39,8 +47,6 @@ Instead, it will copy all the configuration files and the transitive dependencie

You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.

## Learn More

You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
## Contribution

To learn React, check out the [React documentation](https://reactjs.org/).
Please fork the repository, create a branch for your changes, and submit a pull request. Ensure your code follows our standards and includes tests if applicable. We appreciate your contributions!
2 changes: 0 additions & 2 deletions README.old.md

This file was deleted.

0 comments on commit b926054

Please sign in to comment.