diff --git a/README.md b/README.md index 422af8c..5e42d6b 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,26 @@ -#Collate +# Collate Collate is a tool to find out the contributions of each contributor of the project. + It will export collated files formatted in Markdown. Example collated file: [Sebastian Quek.md](collated/Sebastian Quek.md) -##Resources +## Usage +Include `@author` tags to the areas of code you wrote. +```java +// @author John Doe +public class MyCustomClass { + + public MyCustomClass() { + System.out.println("hello"); + } +} +``` + +Commands: +* `collate from