Skip to content

Commit 0eb71c1

Browse files
authored
Merge pull request #107 from AlexWayfer/update_readme
Add "Development", "Contributing" and "License" section into README
2 parents 681354d + 3116eb6 commit 0eb71c1

File tree

2 files changed

+20
-1
lines changed

2 files changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ _[become a backer](https://www.patreon.com/rubycdp_ferrum)_ on Patreon.
5555
* [Frame](https://github.com/rubycdp/ferrum#frame)
5656
* [Dialog](https://github.com/rubycdp/ferrum#dialog)
5757
* [Thread safety](https://github.com/rubycdp/ferrum#thread-safety)
58+
* [Development](https://github.com/rubycdp/ferrum#development)
59+
* [Contributing](https://github.com/rubycdp/ferrum#contributing)
5860
* [License](https://github.com/rubycdp/ferrum#license)
5961

6062

@@ -960,3 +962,21 @@ t2.join
960962

961963
browser.quit
962964
```
965+
966+
## Development
967+
968+
After checking out the repo, run `bundle install` to install dependencies.
969+
970+
Then, run `bundle exec rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
971+
972+
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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
973+
974+
975+
## Contributing
976+
977+
Bug reports and pull requests are welcome on [GitHub](https://github.com/rubycdp/ferrum).
978+
979+
## License
980+
981+
The gem is available as open source under the terms of the
982+
[MIT License](https://opensource.org/licenses/MIT).

Rakefile

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# frozen_string_literal: true
22

3-
require "bundler/setup"
43
require "bundler/gem_tasks"
54
require "rspec/core/rake_task"
65

0 commit comments

Comments
 (0)