Skip to content

Commit 68ce248

Browse files
committed
document how to build the gem locally
1 parent 9284802 commit 68ce248

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

+27
Original file line numberDiff line numberDiff line change
@@ -141,3 +141,30 @@ Patch::Preference.delete_preference(preference_id)
141141
page = 1 # Pass in which page of preferences you'd like
142142
Patch::Preference.retrieve_preferences(page: page)
143143
```
144+
145+
## Development
146+
147+
To build the gem locally, run:
148+
```
149+
$ gem build patch_ruby.gemspec
150+
```
151+
152+
This will create a .gem file. To install the local gem:
153+
```
154+
$ gem install patch_ruby-1.x.x.gem
155+
```
156+
157+
Install dependencies:
158+
```
159+
$ bundle install
160+
```
161+
162+
Set up required environment variables:
163+
```
164+
$ export PATCH_RUBY_API_KEY=<SANDBOX API KEY>
165+
```
166+
167+
Run tests:
168+
```
169+
$ bundle exec rspec
170+
```

0 commit comments

Comments
 (0)