Skip to content

Commit

Permalink
updated readme with install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
sbounmy committed Apr 29, 2024
1 parent 64b5572 commit 9bc829e
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,22 @@ Install the gem and add to the application's Gemfile by executing:
$ bundle add pennylane

If bundler is not being used to manage dependencies, install the gem by executing:
```ruby
# Add to gemfile
gem 'pennylane'
```

$ gem install pennylane
For Rails app :
```ruby
# Create initializers/pennylane.rb
Pennylane.api_key = Rails.application.credentials.dig(:pennylane, :api_key)

# Add credentials to config/credentials.yml.enc
$ EDITOR=vim bin/rails credentials:edit

pennylane:
api_key: 'x0fd....'
```
## Requirements
Ruby 2.3+.

Expand Down

0 comments on commit 9bc829e

Please sign in to comment.