Updated Readme.md file, issue iiitl#7

Karanagarwal12 · Mar 15, 2024 · b7cde8f · b7cde8f
1 parent 0d3f9bc
commit b7cde8f
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -3,6 +3,13 @@
 ## About
 
 Note Generator is a note-taking app for the web.
+It provides following features
+
+1. Adding a note
+2. Updating the note
+3. Deleting any note by double-clicking it
+4. Sort the notes by updated date
+5. Uses local storage hence data is available even after refreshing or closing window and safe also as it does not sends it anywhere
 
 It is a static site without a database, notes are persisted temporarily in local storage
 
@@ -11,19 +18,23 @@ It is a static site without a database, notes are persisted temporarily in local
 - [ ] Install the live - server extension in your favorite text editor( ...really helpful)
 
 ## Demo Development
+- [ ] Click on the go live button on the bottom of the window
 
 ### Clone and Install
 
+- Fork this repo to your github account then clone it in your IDE -
+
 ```
 git clone <repo-link or ssh>
 ```
-
+- Open the file index.html
 
 
 ## Contributing
 
 Note Generator is an open source project, and contributions of any kind are welcome and appreciated. Open issues, bugs, and feature requests are all listed on the [issues](https://github.com/) tab and labeled accordingly. Feel free to open bug tickets and make feature requests. Easy bugs and features will be tagged with the `good first issue` label.
 
+Before making a new PR, make sure to make a new branch and avoid making PR with your main branch.
 
 ## Contributors
 
@@ -38,5 +49,15 @@ Note Generator is an open source project, and contributions of any kind are welc
     </td>
 
   </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/Karanagarwal12">
+    <img src="https://avatars.githubusercontent.com/u/98659780?v=4" width="50px;" alt=""/>
+    <br />
+    <sub><b>Karan Agarwal</b></sub>
+    </a>
+    <br />
+    </td>
+
+  </tr>
 
 </table>
diff --git a/index.html b/index.html
@@ -5,8 +5,6 @@
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
     <title>Notes App</title>
-    <link rel="stylesheet" href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@24,400,0,0" />
-    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css" integrity="sha512-DTOQO9RWCH3ppGqcWaEA1BIZOC6xxalwEsw9c2QQeAIftl+Vegovlnee1c9QX4TctnWMn13TZye+giMm8e2LwA==" crossorigin="anonymous" referrerpolicy="no-referrer" />
     <link rel="stylesheet" href="./css/main.css">
 </head>
 <body>