diff options
author | Star Rauchenberger <fefferburbia@gmail.com> | 2024-12-07 11:49:49 -0500 |
---|---|---|
committer | Star Rauchenberger <fefferburbia@gmail.com> | 2024-12-07 11:49:49 -0500 |
commit | 56f5841d4b9c12296cdfcaeff174b2627d59afc8 (patch) | |
tree | 4f7da4ebbe5ee15a1594b26466ed78e2cf10de35 /README.md | |
parent | c1b0443ba2aebdbd39291ddab0c189f3f4831320 (diff) | |
download | pokeviewer-56f5841d4b9c12296cdfcaeff174b2627d59afc8.tar.gz pokeviewer-56f5841d4b9c12296cdfcaeff174b2627d59afc8.tar.bz2 pokeviewer-56f5841d4b9c12296cdfcaeff174b2627d59afc8.zip |
Migrate to full rails app
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 38 |
1 files changed, 17 insertions, 21 deletions
diff --git a/README.md b/README.md index 2def606..7db80e4 100644 --- a/README.md +++ b/README.md | |||
@@ -1,28 +1,24 @@ | |||
1 | # Pokeviewer | 1 | # README |
2 | Short description and motivation. | ||
3 | 2 | ||
4 | ## Usage | 3 | This README would normally document whatever steps are necessary to get the |
5 | How to use my plugin. | 4 | application up and running. |
6 | 5 | ||
7 | ## Installation | 6 | Things you may want to cover: |
8 | Add this line to your application's Gemfile: | ||
9 | 7 | ||
10 | ```ruby | 8 | * Ruby version |
11 | gem 'pokeviewer' | ||
12 | ``` | ||
13 | 9 | ||
14 | And then execute: | 10 | * System dependencies |
15 | ```bash | ||
16 | $ bundle | ||
17 | ``` | ||
18 | 11 | ||
19 | Or install it yourself as: | 12 | * Configuration |
20 | ```bash | ||
21 | $ gem install pokeviewer | ||
22 | ``` | ||
23 | 13 | ||
24 | ## Contributing | 14 | * Database creation |
25 | Contribution directions go here. | ||
26 | 15 | ||
27 | ## License | 16 | * Database initialization |
28 | The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). | 17 | |
18 | * How to run the test suite | ||
19 | |||
20 | * Services (job queues, cache servers, search engines, etc.) | ||
21 | |||
22 | * Deployment instructions | ||
23 | |||
24 | * ... | ||