-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #28 from codewithsonyy/doc/readme
Doc: updated readme with new tags
- Loading branch information
Showing
1 changed file
with
96 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,103 @@ | ||
| # Notes | ||
| https://srbmaury.github.io/notes/ | ||
| <br/> | ||
| Notes are stored in local storage | ||
| <div align="center"> | ||
| <a href=""> | ||
| <img src="https://i.ibb.co/BLvf6RW/magicnotes.png" alt="Logo" width="260"> | ||
| </a> | ||
|
|
||
| <a id="top-page"></a> | ||
| [](https://github.com/srbmaury) | ||
| [](https://github.com/srbmaury/notes/issues) | ||
|
|
||
| <div align="center"> | ||
|
|
||
| <p align="center"> | ||
|
|
||
| > **_NOTE:_** The code of main.js has some bugs and it is not in use currently. <br /> | ||
| > Notes are stored in local storage | ||
| </p> | ||
| </div> | ||
| <a href="https://srbmaury.github.io/notes/"><strong>View site »</strong></a> | ||
| <br /> | ||
| <br /> | ||
|
|
||
| </p> | ||
| </div> | ||
|
|
||
| ## Description | ||
|
|
||
| “Taking notes” is something that has long been important as we’re going to need to pass along our thoughts, feedback. Magic Notes is a great way to integrate your action plan with your to-do list, bringing your traditional way of taking notes to a whole new level. | ||
| <br /> | ||
| Paste this HTML code above to see the magic: | ||
| https://codepen.io/srbmaury/pen/xxjaxzB | ||
|
|
||
| <h1>Preview:</h1> | ||
| <img src="images/screenshot.png"> | ||
| ## Features | ||
|
|
||
| - Add a new note | ||
| - Delete your previous notes | ||
| - Star Important notes | ||
| - Search within notes | ||
| - Sort by newest first and oldest first | ||
|
|
||
| ### Installation | ||
|
|
||
| Download the Repository from Github or Clone the Repo | ||
|
|
||
| ```sh | ||
| git clone https://github.com/srbmaury/notes.git | ||
| ``` | ||
|
|
||
|  | ||
|
|
||
|  | ||
|
|
||
| ## Project Status[](#project-status) | ||
|
|
||
| <table class="no-border"> | ||
| <tr> | ||
| <td><img src="https://badgen.net/github/stars/srbmaury/notes" alt="CMake build"/></td> | ||
| <td><img src="https://badgen.net/github/forks/srbmaury/notes" alt="CMake build"/></td> | ||
| </tr> | ||
|
|
||
| <tr> | ||
| <td><img src="https://img.shields.io/github/last-commit/srbmaury/notes" alt="CodeQL"/></td> | ||
| <td><img src="https://img.shields.io/github/issues-pr/srbmaury/notes" alt="CPU Architect"/></td> | ||
|
|
||
| </tr> | ||
| </table> | ||
| <br /> | ||
|
|
||
| ## Tech stack | ||
|
|
||
| <br /> | ||
|
|
||
| <div> | ||
| <img height="30" src="https://img.shields.io/badge/html-6DA55F?style=for-the-badge&logo=html&logoColor=white" alt="Git" title="Git" /> | ||
| <img height="30" src="https://img.shields.io/badge/css-%23563D7C.svg?style=for-the-badge&logo=css&logoColor=white" alt="Git" title="Git" /> | ||
| <img height="30" src="https://img.shields.io/badge/javascript-%23323330.svg?style=for-the-badge&logo=javascript&logoColor=%23F7DF1E" alt="Git" title="Git" /> | ||
| <img height="30" src="https://img.shields.io/badge/git-%23F05033.svg?style=for-the-badge&logo=git&logoColor=white" alt="GIT" title="GIT" /> | ||
| <img height="30" src="https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white" alt="Github" title="Github" /> | ||
| </div> | ||
|
|
||
| <br /> | ||
|
|
||
| ## Contributing | ||
|
|
||
| Feel free to open an issue to discuss it, or directly create a pull request with necessary changes. Any contributions you make are greatly appreciated. | ||
|
|
||
| 1. Fork it (<https://github.com/srbmaury/notes.git>) | ||
| 2. Create your feature branch (`git checkout -b feature/login`) | ||
| 3. add and Commit your changes (`git commit -m 'Added login'`) | ||
| 4. Push to the branch (`git push origin feature/login`) | ||
| 5. Create a new Pull Request | ||
|
|
||
| ### Contributors | ||
|
|
||
| <a href="https://github.com/srbmaury/notes/graphs/contributors"> | ||
| <img src="https://contrib.rocks/image?repo=srbmaury/notes" /> | ||
| </a> | ||
|
|
||
| JS won't work as note. 🙂 | ||
| ## Contact info | ||
|
|
||
| <i>The code of main.js has some bugs and it is not in use currently. </i> | ||
| Feel free to contact me if you come through any error or want Guide in contribution. | ||
|
|
||
| <h1>Here you can:</h1> | ||
| <ul> | ||
| <li>Add a new note</li> | ||
| <li>Edit your previous notes</li> | ||
| <li>Delete your previous notes</li> | ||
| <li>Star Important notes</li> | ||
| <li>Search within notes</li> | ||
| <li>Sort by newest first and oldest first</li> | ||
| <ul> | ||
| <a href ="http://www.linkedin.com/in/saurabh-maurya-39b04b205/"><img src="https://img.shields.io/badge/linkedin-%230077B5.svg?style=for-the-badge&logo=linkedin&logoColor=white" alt="Linkedin"/></a> [](mailto:srbmaury@gmail.com) |