Update docs

README.md

@@ -5,6 +5,10 @@ Galaxy Tool Metadata Extractor
 
 ![plot](docs/images/Preprint_flowchart.png)
 
+This tool automatically collects a table of all available Galaxy tools including their metadata. The created table
+can be filtered to only show the tools relevant for a specific community. **Learn [how to add your community](#add-your-community)**. 
+
+The tools performs the following steps:
 - Parse tool GitHub repository from [Planemo monitor listed](https://github.com/galaxyproject/planemo-monitor)
 - Check in each repo, their `.shed.yaml` file and filter for categories, such as metagenomics 
 - Extract metadata from the `.shed.yaml`
@@ -13,6 +17,9 @@ Galaxy Tool Metadata Extractor
 - Extract bio.tools information if available in the macros or xml
 - Check available on the 3 main galaxy instances (usegalaxy.eu, usegalaxy.org, usegalaxy.org.au)
 - Get usage statistics form usegalaxy.eu
+- Creates an interactive table for all tools: [All tools](https://galaxyproject.github.io/galaxy_tool_metadata_extractor/)
+- Creates an interactive table for all registered communities, e.g. [microGalaxy](https://galaxyproject.github.io/galaxy_tool_metadata_extractor/microgalaxy/)
+
 
 # Usage
 
@@ -93,3 +100,14 @@ The script will generate a TSV file with each tool found in the list of GitHub r
         [--keep <Path to to-keep tool file category file>]
     ```
 
+
+## Add your community
+
+In order to add your community you need to:
+- Fork this repository.
+- Add a folder for your community in `data/communities`.
+- Add at least the file `categories`.
+- Add all `categories` that are relevant to initially filter the tools for your community. Possible categories are listed here [Galaxy toolshed](https://toolshed.g2.bx.psu.edu/).
+- Make a pull request to add your community.
+- The workflow will run every sunday, so on the next monday, your community table should be added to `results/<your community name>`
+