Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve readme formatting #704

Merged
merged 1 commit into from
Jan 6, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 17 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Psych

* https://github.com/ruby/psych
* https://docs.ruby-lang.org/en/master/Psych.html
* https://github.com/ruby/psych
* https://docs.ruby-lang.org/en/master/Psych.html

## Description

Expand All @@ -22,31 +22,38 @@ Psych.dump("foo") # => "--- foo\n...\n"

## Dependencies

* libyaml
* libyaml

## Installation

Psych has been included with MRI since 1.9.2, and is the default YAML parser
in 1.9.3.

If you want a newer gem release of Psych, you can use rubygems:

gem install psych
If you want a newer gem release of Psych, you can use RubyGems:

```bash
gem install psych
```

Psych supported the static build with specific version of libyaml sources. You can build psych with libyaml-0.2.5 like this.

gem install psych -- --with-libyaml-source-dir=/path/to/libyaml-0.2.5
```bash
gem install psych -- --with-libyaml-source-dir=/path/to/libyaml-0.2.5
```

In order to use the gem release in your app, and not the stdlib version,
you'll need the following:

gem 'psych'
require 'psych'
```ruby
gem 'psych'
require 'psych'
```

Or if you use Bundler add this to your `Gemfile`:

gem 'psych'
```ruby
gem 'psych'
```

JRuby ships with a pure Java implementation of Psych.

Expand Down