Update README.md

README.md

@@ -8,4 +8,26 @@ pinned: false
 license: apache-2.0
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+A simple File Storing and Retrieving tool for personal use.
+
+- Uses Flask to manage access and perform actions on the data.
+- User can Upload and Delete the data files.
+- Uses MongoDB for storage.
+- Uses simple authetication via secret key in the virtual production environment.
+
+Hosted on HuggingFace:
+> [File Storage System](https://abhicodes-file-storage-system.hf.space)
+
+To set up your own tool just duplicate the repo. Add the following Environment variables:
+
+1. **SECRET_KEY**= *-- Your Super Secret Key --*
+2. **APP_PASSWORD**= *-- Your authetication password --*
+3. **MONGO_USERNAME**= *-- Your MongoDB username for Cluster --*
+4. **MONGO_PASSWORD**= *-- Your MongoDB password for Cluster --*
+5. **REST_URI**= *-- Rest URI of that Cluster --*
+
+> **NOTE :** The default username for the application is setup to be **'admin'**. (*You can change it in the code at **line 33**, inside **check_auth() function***)
+
+> **NOTE :** While setting up MongoDB Cluster save the username and password somewhere safe. The name of the cluster (*used in Rest URI*) can be anything. The databse name must be **'file_storage'** and the collection inside it must be **'files'** if you don't want to tamper with the code.
+
+> **NOTE :** To get more knowledge about MongoDB setup got to this reference: [MongoDB - PyMongo Docs](https://www.mongodb.com/docs/languages/python/pymongo-driver/current/get-started/)