Skip to content

Commit 0b2c338

Browse files
committed
Update README content
1 parent 48316af commit 0b2c338

File tree

1 file changed

+30
-53
lines changed

1 file changed

+30
-53
lines changed

README.md

Lines changed: 30 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,68 +1,45 @@
1-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
1+
# OpenApps - Quick Notes
22

3-
## Available Scripts
3+
Quick Notes is a [PWA](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) pet project, that allows you to take notes and save them to your local machine. You can export your current note list or import a backup note list. Notes are converted to base64 when saved to your local machine. Functionality highlights:
4+
* Save notes to your local machine.
5+
* Export and import notes.
6+
* Copy the active note with one button.
7+
* Clear the note text area with one button.
8+
* Toolbox menu to convert active note to upper or lower case. Trim option to remove excess white space.
9+
* Quick save button.
410

5-
In the project directory, you can run:
11+
## Getting Started
612

7-
### `npm start`
13+
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
814

9-
Runs the app in the development mode.<br />
10-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
15+
### Prerequisites
1116

12-
The page will reload if you make edits.<br />
13-
You will also see any lint errors in the console.
17+
* Get Node JS setup and configured. See [this link](https://www.tutorialspoint.com/nodejs/nodejs_environment_setup.htm) for guidance.
18+
* Additional reading material at [this link](https://www.tutorialspoint.com/reactjs/reactjs_quick_guide.htm) for getting started with React.
1419

15-
### `npm test`
20+
### Installing
1621

17-
Launches the test runner in the interactive watch mode.<br />
18-
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
22+
* Clone the project to your local machine.
23+
* In the project folder, run
24+
...
25+
npm start
26+
...
27+
* Follow [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started) form more information.
1928

20-
### `npm run build`
29+
## Built With
2130

22-
Builds the app for production to the `build` folder.<br />
23-
It correctly bundles React in production mode and optimizes the build for the best performance.
31+
* [Bootstrap](https://getbootstrap.com/) - Layout and decoration
32+
* [React](https://reactjs.org/) - Web framework
33+
* [NPM](https://www.npmjs.com/) - Dependency management
2434

25-
The build is minified and the filenames include the hashes.<br />
26-
Your app is ready to be deployed!
35+
## Authors
2736

28-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
37+
* **OpenApps Founder** - *Initial work* - [GitHub](https://github.com/openXapps/)
2938

30-
### `npm run eject`
39+
## License
3140

32-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
41+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
3342

34-
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
43+
## Wish List
3544

36-
Instead, it will copy all the configuration files and the transitive dependencies (Webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
37-
38-
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.
39-
40-
## Learn More
41-
42-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
43-
44-
To learn React, check out the [React documentation](https://reactjs.org/).
45-
46-
### Code Splitting
47-
48-
This section has moved here: https://facebook.github.io/create-react-app/docs/code-splitting
49-
50-
### Analyzing the Bundle Size
51-
52-
This section has moved here: https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size
53-
54-
### Making a Progressive Web App
55-
56-
This section has moved here: https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app
57-
58-
### Advanced Configuration
59-
60-
This section has moved here: https://facebook.github.io/create-react-app/docs/advanced-configuration
61-
62-
### Deployment
63-
64-
This section has moved here: https://facebook.github.io/create-react-app/docs/deployment
65-
66-
### `npm run build` fails to minify
67-
68-
This section has moved here: https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify
45+
* TBA

0 commit comments

Comments
 (0)