guillaume
/
librarix
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add README

master
Guillaume Dott 2015-10-23 12:27:28 +02:00
parent 1bdd77ea23
commit 75e122b00d
2 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,10 +1,14 @@
# Librarix # Librarix
TODO: Write a gem description Manage all your collections in your browser and automatically fetch infos from TheMovieDB
## Installation ## Installation
Add this line to your application's Gemfile: Librarix is a simple Sinatra app that can be used as a standalone app or mounted in another app.
### Standalone
Create a Gemfile and add this line:
```ruby ```ruby
gem 'librarix' gem 'librarix'
@ -12,20 +16,16 @@ gem 'librarix'
And then execute: And then execute:
```sh
$ bundle $ bundle
```
Or install it yourself as: Finally, you need a `config.ru` file to launch the Rack application:
```ruby
require 'librarix'
$ gem install librarix Tmdb::Api.key('THE_MOVIE_DB_API_KEY')
Librarix.redis = Redis.new # use the correct host, port and db number for your redis database
## Usage run Librarix::Application
```
TODO: Write usage instructions here
## Contributing
1. Fork it ( https://github.com/[my-github-username]/librarix/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

2
librarix.gemspec
View File

@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
spec.version = Librarix::VERSION spec.version = Librarix::VERSION
spec.authors = ["Guillaume Dott"] spec.authors = ["Guillaume Dott"]
spec.email = ["guillaume+github@dott.fr"] spec.email = ["guillaume+github@dott.fr"]
spec.summary = %q{A simple webapp to manage your collections} spec.summary = %q{A simple webapp to manage your movie collection}
spec.description = %q{Manage all your collections in your browser and automatically fetch infos from TheMovieDB} spec.description = %q{Manage all your collections in your browser and automatically fetch infos from TheMovieDB}
spec.homepage = "" spec.homepage = ""
spec.license = "MIT" spec.license = "MIT"