Skip to content

Commit

Permalink
update readme and homepage
Browse files Browse the repository at this point in the history
Signed-off-by: Sathish <sbabu@progress.com>
  • Loading branch information
sathish-progress committed Apr 11, 2023
1 parent 7982a67 commit 6a3a5fc
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
# YAMLSafeLoadStream provided by `yaml-safe_load_stream3`
[![Gem Version](https://badge.fury.io/rb/yaml-safe_load_stream3.svg)](https://badge.fury.io/rb/yaml-safe_load_stream3)
[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/tsutsu/yaml-safe_load_stream3/master)
[![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/inspec/yaml-safe_load_stream3/master)

### Before you begin...

The `yaml-safe_load_stream3` project is a fork of [tsutsu/yaml-safe_load_stream2](https://github.com/tsutsu/yaml-safe_load_stream2).
We made `::YAML.parse_stream` accept parametrized args and raise `Psych::DisallowedClass` as per ruby 3.1 new way of
passing args. The library was renamed in order to publish it to
Rubygems without conflicting with `yaml-safe_load_stream` and `yaml-safe_load_stream2`.

The `yaml-safe_load_stream3` project is a fork of
[kontena/k8s-client](https://github.com/kontena/yaml-safe_load_stream).

Expand Down Expand Up @@ -95,4 +100,4 @@ Or install it yourself as:

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/tsutsu/yaml-safe_load_stream3
Bug reports and pull requests are welcome on GitHub at https://github.com/inspec/yaml-safe_load_stream3
2 changes: 1 addition & 1 deletion yaml-safe_load_stream3.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Gem::Specification.new do |spec|

spec.summary = %q{Adds YAML.safe_load_stream for safely parsing multi-document YAML streams}
spec.description = %q{The Ruby standard library defines YAML.safe_load and YAML.load_stream but there's no way to safely load a multi document stream. This Gem adds YAML.safe_load_stream.}
spec.homepage = "https://github.com/sathish-progress/yaml-safe_load_stream3"
spec.homepage = "https://github.com/inspec/yaml-safe_load_stream3"

spec.files = Dir[*%w(lib/yaml/safe_load_stream.rb lib/yaml/safe_load_stream/core-ext.rb LICENSE README.md)]
spec.require_paths = ["lib"]
Expand Down

0 comments on commit 6a3a5fc

Please sign in to comment.