-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updater task and add [email protected] assets
- Loading branch information
Showing
7 changed files
with
2,349 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,43 +1,64 @@ | ||
# PopperJs | ||
|
||
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/popper_js`. To experiment with that code, run `bin/console` for an interactive prompt. | ||
|
||
TODO: Delete this and the text above, and describe your gem | ||
This gem packages [popper.js](https://popper.js.org/) for use with Sprockets, | ||
the Rails asset pipeline. | ||
|
||
## Installation | ||
|
||
Add this line to your application's Gemfile: | ||
|
||
```ruby | ||
gem 'popper_js' | ||
gem 'popper_js', '~> 1.9.9' | ||
``` | ||
|
||
And then execute: | ||
|
||
$ bundle | ||
|
||
Or install it yourself as: | ||
|
||
$ gem install popper_js | ||
```bash | ||
bundle | ||
``` | ||
|
||
## Usage | ||
|
||
TODO: Write usage instructions here | ||
Require `popper` from your `application.js`: | ||
|
||
```js | ||
//= require popper | ||
``` | ||
|
||
## 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. | ||
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 update the bundled Popper.js assets to the latest version, run: | ||
|
||
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). | ||
```bash | ||
rake update | ||
``` | ||
|
||
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]/popper_js. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. | ||
Bug reports and pull requests are welcome on GitHub | ||
at https://github.com/glebm/popper_js-rubygem. This project is intended to be a | ||
safe, welcoming space for collaboration, and contributors are expected to adhere | ||
to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. | ||
|
||
## License | ||
|
||
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT). | ||
The gem is available as open source under the terms of | ||
the [MIT License](http://opensource.org/licenses/MIT). | ||
|
||
## Code of Conduct | ||
|
||
Everyone interacting in the PopperJs project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/popper_js/blob/master/CODE_OF_CONDUCT.md). | ||
Everyone interacting in the PopperJs project’s codebases, issue trackers, | ||
chat rooms and mailing lists is expected to follow the [code of conduct]. | ||
|
||
[code of conduct]: https://github.com/glebm/popper_js-rubygem/blob/master/CODE_OF_CONDUCT.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.