Merge branch 'master' of github.com:knowledgesystems/mutationhotspots

knowledgesystems · Mar 5, 2017 · 0a5aa8b · 0a5aa8b
2 parents 4666fb1 + eab68ca
commit 0a5aa8b
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,2 +1,13 @@
 # mutationhotspots
-Algorithms to detect mutational hotspots
+Algorithms to detect mutational hotspots. Currently, MutationHotspotsDetection only supports detection of intra-chain hotspots in 3D protein structures.
+
+Binary JAR file is available in [releases](https://github.com/knowledgesystems/mutationhotspots/releases).
+
+## Usage
+
+
+`java -jar MutationHotspotsDetection-1.0.0.jar <input.maf> <output.results.txt>`
+
+Here is [an example input MAF file](https://github.com/knowledgesystems/mutationhotspots/blob/1.0.0/MutationHotspotsDetection/src/main/resources/data/example.maf)
+
+Either `ENSP` or `SWISSPROT` should have data for each mutation. `CODE` is not required. All other columns are required.