Skip to content

Commit 4b71492

Browse files
authored
update readme (#9)
* update readme * add TargetRubyVersion
1 parent cfcd782 commit 4b71492

File tree

4 files changed

+44
-8
lines changed

4 files changed

+44
-8
lines changed

.rubocop.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ require:
44
AllCops:
55
SuggestExtensions: true
66
NewCops: enable
7+
TargetRubyVersion: 3.2
78

89
Metrics/BlockLength:
910
Exclude:

CONTRIBUTING.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing
2+
3+
We love pull requests from everyone. By participating in this project, you
4+
agree to abide by the [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
5+
6+
Fork, then clone the repo:
7+
8+
git clone git@github.com:your-username/json_logic_ruby.git
9+
10+
Set up your machine:
11+
12+
bundle install
13+
14+
Make sure the tests pass:
15+
16+
rspec
17+
18+
Make your change. Add tests for your change. Make the tests pass:
19+
20+
rspec
21+
22+
Push to your fork and [submit a pull request][pr].
23+
24+
[pr]: https://github.com/useful-libs/json_logic_ruby/compare/
25+
26+
At this point you're waiting on us. We like to at least comment on pull requests
27+
within three business days (and, typically, one business day). We may suggest
28+
some changes or improvements or alternatives.
29+
30+
Some things that will increase the chance that your pull request is accepted:
31+
32+
* Write tests.
33+
* Write a [good commit message][commit], using also [release-please approach][release-please]
34+
35+
[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
36+
[release-please]: https://github.com/googleapis/release-please

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@ Build rules and execute them in ruby. See https://jsonlogic.com
77

88
Install the gem and add to the application's Gemfile by executing:
99

10-
$ bundle add json_logic
10+
$ bundle add json_logic_ruby
1111

1212
If bundler is not being used to manage dependencies, install the gem by executing:
1313

14-
$ gem install json_logic
14+
$ gem install json_logic_ruby
1515

1616
## Usage
1717
#### Run json-logic:
@@ -55,18 +55,16 @@ puts logic.tracker.report
5555

5656
## Development
5757

58-
After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
59-
60-
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).
58+
After checking out the repo, run `bundle install` to install dependencies.
6159

6260
## Contributing
6361

64-
Bug reports and pull requests are welcome on GitHub at https://github.com/useful-libs/json-logic. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/useful-libs/json-logic/blob/main/CODE_OF_CONDUCT.md).
62+
Please see [CONTRIBUTING.md](CONTRIBUTING.md).
6563

6664
## License
6765

6866
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
6967

7068
## Code of Conduct
7169

72-
Everyone interacting in the Json::Logic project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/useful-libs/json-logic/blob/master/CODE_OF_CONDUCT.md).
70+
Everyone interacting in the Json::Logic project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/useful-libs/json_logic_ruby/blob/main/CODE_OF_CONDUCT.md).

json_logic.gemspec

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,11 @@ Gem::Specification.new do |spec|
66
spec.name = 'json_logic_ruby'
77
spec.version = JsonLogic::VERSION
88
spec.authors = ['Volodymyr Stashchenko', 'Andriy Savka']
9+
spec.email = %w[stashchenko@ukr.net savka.ai2015@gmail.com]
910

1011
spec.summary = 'Build complex rules, serialize them as JSON, and execute them in ruby.'
1112
spec.description = 'Build complex rules, serialize them as JSON, and execute them in ruby. See https://jsonlogic.com'
12-
spec.homepage = 'https://github.com/useful-libs/json_logic'
13+
spec.homepage = 'https://github.com/useful-libs/json_logic_ruby'
1314

1415
spec.license = 'MIT'
1516
spec.required_ruby_version = '>= 3.2.0'

0 commit comments

Comments
 (0)