README.md in render_editorjs-0.1.0 vs README.md in render_editorjs-0.1.1
- old
+ new
@@ -39,11 +39,11 @@
### Common usage
```ruby
renderer = RenderEditorjs::DefaultRenderer.new
-document = RenderEditorjs::Document.new(renderer, json)
+document = RenderEditorjs::Document.new(json, renderer)
document.valid? #=> true | false
document.errors #=> Array with the schema errors
document.render #=> HTML...
```
@@ -52,19 +52,19 @@
Customize the DefaultRenderer adding or overriding blocks:
```ruby
renderer = RenderEditorjs::DefaultRenderer.new("header" => MyCustomHeader.new, "customBlock" => CustomBlock.new)
-document = RenderEditorjs::Document.new(renderer, json)
+document = RenderEditorjs::Document.new(json, renderer)
document.render #=> My custom HTML
```
Create your renderer class:
```ruby
renderer = MyOwnRenderer.new
-document = RenderEditorjs::Document.new(renderer, json)
+document = RenderEditorjs::Document.new(json, renderer)
document.render #=> My custom HTML
```
## Development
@@ -72,15 +72,15 @@
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]/editorjs. 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/[USERNAME]/editorjs/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/ceritium/render_editorjs. 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/ceritium/render_editorjs/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
-Everyone interacting in the Editorjs project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/editorjs/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the RenderEditorjs project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ceritium/render_editorjs/blob/master/CODE_OF_CONDUCT.md).