about summary refs log tree commit diff stats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md28
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
2Short description and motivation.
3
4## Usage
5How to use my plugin.
6
7## Installation
8Add this line to your application's Gemfile:
9
10```ruby
11gem 'pokeviewer'
12```
13
14And then execute:
15```bash
16$ bundle
17```
18
19Or install it yourself as:
20```bash
21$ gem install pokeviewer
22```
23
24## Contributing
25Contribution directions go here.
26
27## License
28The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).