Skip to content

Commit 4329e9c

Browse files
committed
Improve README
1 parent 46afc9f commit 4329e9c

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# Jquery::Base64::Rails
22

3-
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/jquery/base64/rails`. To experiment with that code, run `bin/console` for an interactive prompt.
4-
5-
TODO: Delete this and the text above, and describe your gem
3+
[jquery-base64](https://github.com/carlo/jquery-base64) for Rails.
64

75
## Installation
86

@@ -22,17 +20,16 @@ Or install it yourself as:
2220

2321
## Usage
2422

25-
TODO: Write usage instructions here
26-
27-
## Development
23+
In your application.js you will need to add this line:
2824

29-
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.
25+
```
26+
//= require jquery-base64
27+
```
3028

31-
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).
3229

3330
## Contributing
3431

35-
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jquery-base64-rails.
32+
Bug reports and pull requests are welcome on GitHub at https://github.com/inventit/jquery-base64-rails.
3633

3734
## License
3835

0 commit comments

Comments
 (0)