Update README

README.md

@@ -1,3 +1,36 @@
-# linter-ruby package
+linter-ruby
+=========================
 
-This package no yet ready.
+This linter plugin for [Linter](https://github.com/AtomLinter/Linter) provides an interface to Ruby's builtin syntax analysis. It will be used with files that have the `Ruby` syntax.
+
+## Installation
+Linter package must be installed in order to use this plugin. If Linter is not installed, please follow the instructions [here](https://github.com/AtomLinter/Linter).
+
+### Plugin installation
+```
+$ apm install linter-ruby
+```
+
+## Settings
+You can configure linter-ruby by editing ~/.atom/config.cson (choose Open Your Config in Atom menu):
+```
+'linter-ruby':
+  'rubyExecutablePath': null #ruby path. run 'which ruby' to find the path.
+```
+
+## Contributing
+If you would like to contribute enhancements or fixes, please do the following:
+
+1. Fork the plugin repository.
+1. Hack on a separate topic branch created from the latest `master`.
+1. Commit and push the topic branch.
+1. Make a pull request.
+1. welcome to the club
+
+Please note that modifications should follow these coding guidelines:
+
+- Indent is 2 spaces.
+- Code should pass coffeelint linter.
+- Vertical whitespace helps readability, don’t be afraid to use it.
+
+Thank you for helping out!