Update README.md

README.md

@@ -1,5 +1,5 @@
 # cursely
-*Browse and download minecraft mods from Curseforge.*
+*Browse and download Minecraft mods from Curseforge.*
 <br>
 <br>
 <br>
@@ -27,3 +27,65 @@
   <img width="600" src="https://i.imgur.com/odRylG8.png">
 </p>
 <br>
+
+## Installation
+> To use [cursely](https://github.com/julynx/cursely) you need a [Curseforge API key](https://console.curseforge.com/?#/signup).
+
+The first step is to install the required dependencies:
+```
+pip3 install prettytable numerize
+```
+
+Then, clone the repository and install the executable files:
+```
+git clone https://github.com/julynx/cursely /tmp/cursely
+sudo chmod +x /tmp/cursely/cursely*
+sudo cp /tmp/cursely/cursely* /usr/bin
+```
+
+<br>
+
+## Usage
+
+Cursely will ask for your Minecraft version, loader (Fabric or Forge), and API key when you run it for the first time, and will save those settings to ```.config/cursely/config.json```. From now on, it will only show mods compatible with that configuration.
+
+You can now run the ```cursely``` command followed by any of the arguments listed below:
+```
+  cursely             Browse popular recently updated mods.
+  cursely [MOD_ID]    Get a brief description of a mod and its download link.
+  cursely [KEYWORD]   Search a mod by its name or author.
+  cursely [MODPACK]   Install all listed mods and their dependencies.
+```
+
+<br>
+
+## Modpacks
+
+A modpack file is a Markdown file ```.md``` with the following format:
+```
+example_modpack.md
+
+  # This line is a comment and will be ignored
+  $ This is a bash command that will be executed
+  12345 Name of mod with ID=12345
+  67890 Name of mod with ID=67890
+  ...
+```
+
+Running ```cursely example_modpack.md``` will:
+1) Download and install the listed mods.
+2) Download and install their required dependencies.
+3) Execute all the commands specified in the file.
+4) Print any errors that might have occurred.
+
+You can also use the ```cursely_modpack``` command, followed by the name of a modpack file (minus the extension) hosted in this repository to retrieve and deploy it.
+
+For example, ```cursely_modpack magical_souls``` will fetch and install the modpack file ```github.com/julynx/cursely/magical_souls.md```.
+
+<br>
+
+## Uninstalling
+To uninstall [cursely](https://github.com/julynx/cursely), delete the executables and the configuration using the command:
+```
+sudo rm -rf /usr/bin/cursely* ~/.config/cursely
+```