Skip to content

Commit

Permalink
Updated README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pratyaksh1610 authored Sep 11, 2022
1 parent ef17c89 commit ddffd5f
Showing 1 changed file with 82 additions and 3 deletions.
85 changes: 82 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,93 @@
# Notes App in Kotlin
# 📒Notes


## 📱 Note taking Android App made using Kotlin

***You can Install and test latest Notes app below 👇*** <br>

### Get Apk [Download here](https://raw.githubusercontent.com/pratyaksh1610/Notes_App/main/app/app-release.apk)
------------

## ⚙️ Features
* UI - Provides a clean and interactive UI.
* Plain Text Notes - Take short and descriptive notes.
* Re-edit Notes - Re-edit or Update Your Notes.
* Delete Notes - Delete Notes using One Touch.
* Share notes - Share notes with your friends.
* Save notes - Save notes within the app for future reference.

## 🚀 Technology Used

- Kotlin
- MVVM
- Room DB
- Room
- LiveData
- ViewModel
- Recycler View

## 📸Screeshots

<p float="left">
<img src="https://user-images.githubusercontent.com/76740999/189541728-09ff220e-b855-4a9e-94c8-38057e3e87d6.png" width="310" />
<img src="https://user-images.githubusercontent.com/76740999/187928365-a1f56ae9-f3fb-4919-936b-c19597bb2dba.png" width="300" />
<img src="https://user-images.githubusercontent.com/76740999/187928372-d9e9a8fc-77c7-4b1f-9282-975ab651384a.png" width="300" />
<img src="https://user-images.githubusercontent.com/76740999/187928375-00e5e9fd-b4bd-4159-a45f-c13849b60c6e.png" width="300" />
<img src="https://user-images.githubusercontent.com/76740999/187928379-83f96b2d-4903-4b9a-bfde-671fa7f112e1.png" width="300" />
<img src="https://user-images.githubusercontent.com/76740999/187928391-1c04adc4-8025-47cc-8d9d-489ad9e19cf3.png" width="300" />
<img src="https://user-images.githubusercontent.com/76740999/187928391-1c04adc4-8025-47cc-8d9d-489ad9e19cf3.png" width="310" />
</p>


## :label: Getting Started

* First, fork the repository (Click the <b><b>Fork</b></b> button in the top right corner of the page).
* Clone the forked repository to your local machine.

```markdown
https://github.com/your-username/Notes_App.git
```

* Add upstream URL
```markdown
https://github.com/pratyaksh1610/Notes_App.git
```

* Create a new branch

```markdown
git checkout -b branch_name
```

* Make your contribution
* Commit and push the changes

```markdown
git add .
git commit -m 'Relevant message'
git push origin branch_name
```

* Create a new pull request from your forked repository (Click the `New Pull Request` button located at the top of your repo)
* Wait for your PR review and approval from the maintainers.
* :star: this repository if you liked it.


## License
```
MIT License
Copyright (c) 2022 Pratyaksh Khurana
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.
```

0 comments on commit ddffd5f

Please sign in to comment.