kotovalexarian-likes-github
/
kaminari--kaminari
mirror of https://github.com/kaminari/kaminari.git
1
0
Fork 0
Code Releases Activity

📝 README

This commit is contained in:
Akira Matsuda 2016-10-05 07:17:44 +09:00
parent b6b7ff2307
commit b5b55e9ba2
1 changed files with 4 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
kaminari-core/README.md
View File

@ -1,8 +1,7 @@
# Kaminari::Core
Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/kaminari/core`. To experiment with that code, run `bin/console` for an interactive prompt.
Kaminari core libraries.
TODO: Delete this and the text above, and describe your gem
## Installation
@ -12,30 +11,19 @@ Add this line to your application's Gemfile:
gem 'kaminari-core'
```
And then execute:
And bundle.
$ bundle
Or install it yourself as:
$ gem install kaminari-core
## Usage
TODO: Write usage instructions here
This gem is basically an internal gem that will be automatically bundled from kaminari gem.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/kaminari-core.
Pull requests are welcome on GitHub at https://github.com/amatsuda/kaminari.
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).