diff options
| author | Kelly Rauchenberger <fefferburbia@gmail.com> | 2017-09-16 18:46:55 -0400 |
|---|---|---|
| committer | Kelly Rauchenberger <fefferburbia@gmail.com> | 2017-09-16 18:46:55 -0400 |
| commit | 5e62e771bf14f58dd1622d2e3631309caa201349 (patch) | |
| tree | 76143baae833a4cfe0e05cefb18b5a31d15b74e9 /README.md | |
| download | pokeviewer-5e62e771bf14f58dd1622d2e3631309caa201349.tar.gz pokeviewer-5e62e771bf14f58dd1622d2e3631309caa201349.tar.bz2 pokeviewer-5e62e771bf14f58dd1622d2e3631309caa201349.zip | |
Initial commit
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 28 |
1 files changed, 28 insertions, 0 deletions
| diff --git a/README.md b/README.md new file mode 100644 index 0000000..2def606 --- /dev/null +++ b/README.md | |||
| @@ -0,0 +1,28 @@ | |||
| 1 | # Pokeviewer | ||
| 2 | Short description and motivation. | ||
| 3 | |||
| 4 | ## Usage | ||
| 5 | How to use my plugin. | ||
| 6 | |||
| 7 | ## Installation | ||
| 8 | Add this line to your application's Gemfile: | ||
| 9 | |||
| 10 | ```ruby | ||
| 11 | gem 'pokeviewer' | ||
| 12 | ``` | ||
| 13 | |||
| 14 | And then execute: | ||
| 15 | ```bash | ||
| 16 | $ bundle | ||
| 17 | ``` | ||
| 18 | |||
| 19 | Or install it yourself as: | ||
| 20 | ```bash | ||
| 21 | $ gem install pokeviewer | ||
| 22 | ``` | ||
| 23 | |||
| 24 | ## Contributing | ||
| 25 | Contribution directions go here. | ||
| 26 | |||
| 27 | ## License | ||
| 28 | The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). | ||