Skip to content

Commit

Permalink
[Readme & License] Added Readme and License
Browse files Browse the repository at this point in the history
  • Loading branch information
10cyrilc committed Feb 9, 2023
1 parent f657597 commit aaa12d7
Show file tree
Hide file tree
Showing 2 changed files with 75 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2022 Cyril C Thomas

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
54 changes: 54 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
Notes App
=========

A simple and intuitive notes app built with React Native, Expo, React Navigation, and Async Storage. With its clean and minimalistic design, taking and organizing notes has been made easier!

Features
--------

* Create and edit notes
* Organize notes with title
* Set reminders for notes
* Dark mode for better reading capability

Getting Started
---------------

1. Clone the repository to your local machine.


`git clone https://github.com/10cyrilc/notes-app.git`

2. Navigate to the project directory.


`cd notes-app`

3. Install the required dependencies.

`npm install`

4. Start the development server.

`npm start`

Built With
----------

* [React Native](https://facebook.github.io/react-native/) - A framework for building native apps using React
* [Expo](https://expo.dev/) - Expo is an open-source platform for making universal native apps for Android, iOS, and the web with JavaScript and React.
* [React Navigation](https://reactnavigation.org/) - Routing and navigation for your React Native apps
* [Async Storage](https://github.com/react-native-community/async-storage) - A simple, unencrypted, asynchronous, persistent, storage system for React Native.

Contributing
------------

If you are interested in contributing to this project, feel free to fork the repository and submit a pull request. Your contributions are always welcome!
## Authors

- [@10cyrilc](https://www.github.com/10cyrilc)


## Support Me

<a href="https://www.buymeacoffee.com/10cyrilc" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>

0 comments on commit aaa12d7

Please sign in to comment.