readme reworked

Author: Agustín Rodríguez

README.md

@@ -1,6 +1,10 @@
 # bashme
 
-Bashme is a JavaScript library which provides a nerdy way to tell people about you. It was created with the intention to use it as a resumé replacement but it can also have other use cases. It aims to be customizable, extensible and easy to use.
+Bashme is a library which provides a nerdy way to tell people about you. It was created with the intention to use it as a resumé replacement but I it can have other use cases. It aims to be customizable, extensible and easy to use.
+
+## Demo
+
+Play with it in my personal website: http://agurodriguez.net
 
 ## Getting Started
 
@@ -13,35 +17,81 @@ npm install bashme
 Use it:
 
 ```js
-var bashme = new Bashme.default();
-bashme.use(new Bashme.GitHub(process.env.GITHUB_APP_KEY, process.env.GITHUB_SECRET);
+var bashme = new Bashme.Bashme();
+bashme.use(new Bashme.GitHub('agurodriguez'));
 bashme.show(document.querySelector('#bashme'));
 ```
 
 Full code in [example](example) folder.
 
 > If you use react, you can try [react-bashme](https://github.com/agurodriguez/react-bashme).
 
-## Contributing
+## A bit into the code
 
-### About the `bashme` instance
+### The `Bashme` instance
 
-A `bashme` instance is the library's entry point and is reponsible to process input/output from/to the terminal and to run the tasks related to every given command.
+`Bashme` is the main class which acts as library's entry point. It's reponsible for processing the input/output from/to the terminal and for running the tasks related to every given command.
 
-It has two important methods, `use` and `show`, explained in the following paragraphs:
+It has two important methods, `use` and `show`:
 
-#### `use(infoProvider: InfoProvider)` 
+#### `use(provider: IProvider)` 
 
-This method registers a new `InfoProvider` in the `bashme` instance. When the `InfoProvider` is registerd it adds commands to the `bashme` instance that can be called by the user.
+This method registers a new `IProvider` in the `Bashme` instance. When the `IProvider` is registerd it adds commands to the `Bashme` instance that can be called by the user.
 
 #### `show(domElement: HTMLElement)` 
 
 This method converts an `HTMLElement` into a full interactive terminal (Using [`xterm.js`]()) to allow users to write the commands they want to execute.
 
-### Adding an InfoProvider
+### Providers
+
+A provider is a class that implements the [`IProvider`](src/provider/types/index.ts) interface and provides commands to the `Bashme` instance that the user can then execute.
+
+### Commands
+
+A command is a class that inhertis from the [`AsyncCommand`](src/command/types/index.ts) or the [`SyncCommand`](src/command/types/index.ts) classes and are used to perform some specific action.
+
+## Built-in Providers
+
+### GitHub
+
+See [GitHub.ts](src/provider/GitHub.ts)
+
+#### Commands
+
+| Command           | Description                      |
+|-------------------|----------------------------------|
+| `github`          | Shows GitHub profile information           
+| `github contribs` | Shows GitHub contributions
+| `github orgs`     | Shows GitHub organizations
+| `github repos`    | Shows GitHub repositories
+
+### Json
+
+See [Json.ts](src/provider/Json.ts)
+
+#### Commands
+
+| Command           | Description                      |
+|-------------------|----------------------------------|
+| `name`            | Shows name    
+| `bio`             | Shows bio
+| `education`       | Shows education
+| `work`            | Shows work experience
+| `volunteer`       | Shows volunteer experience
+| `awards`          | Shows awards
+| `publications`    | Shows publications
+| `skills`          | Shows skills
+| `languages`       | Shows languages
+
+## License
 
-A provider is a class that implements the [`InfoProvider`]() interface and is reponsible for filling the [`resumé`]() properties and for adding commands to the `bashme` instance.
+[MIT License](LICENSE)
 
-### Adding a Command
+Copyright (c) 2018 Agustín Rodríguez
 
-A command is a class that implements the [`Command`]() interface and is used to perform some actions when a specific command is given.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions: