Skip to content

Commit 2d33fdb

Browse files
committed
init docs
1 parent 3e60c5b commit 2d33fdb

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,37 @@
88
A Pluggable Webhook Server Framework written in Ruby
99

1010
![hooks](docs/assets/hooks.png)
11+
12+
## Installation 💎
13+
14+
You can download this Gem from [GitHub Packages](https://github.com/github/hooks/pkgs/rubygems/hooks-ruby) or [RubyGems](https://rubygems.org/gems/hooks-ruby)
15+
16+
Via a Gemfile:
17+
18+
```ruby
19+
source "https://rubygems.org"
20+
21+
gem "hooks-ruby", "~> X.X.X" # Replace X.X.X with the latest version
22+
```
23+
24+
## Usage 💻
25+
26+
### Basic
27+
28+
```ruby
29+
# file: config.ru
30+
require "hooks-ruby"
31+
32+
app = Hooks.build(config: "hooks.yaml")
33+
run app
34+
```
35+
36+
Run the hooks server:
37+
38+
```bash
39+
bundle exec puma --tag hooks
40+
```
41+
42+
### Advanced
43+
44+
TODO

0 commit comments

Comments
 (0)