1
- # libnpmhook [ ![ npm version] ( https://img.shields.io/npm/v/libnpmhook.svg )] ( https://npm.im/libnpmhook ) [ ![ license] ( https://img.shields.io/npm/l/libnpmhook.svg )] ( https://npm.im/libnpmhook ) [ ![ Travis] ( https://img.shields.io/travis/npm/libnpmhook.svg )] ( https://travis-ci.org/npm/libnpmhook ) [ ![ AppVeyor] ( https://ci.appveyor.com/api/projects/status/github/zkat/libnpmhook?svg=true )] ( https://ci.appveyor.com/project/zkat/libnpmhook ) [ ![ Coverage Status] ( https://coveralls.io/repos/github/npm/libnpmhook/badge.svg?branch=latest )] ( https://coveralls.io/github/npm/libnpmhook?branch=latest )
1
+ # libnpmhook
2
+
3
+ [ ![ npm version] ( https://img.shields.io/npm/v/libnpmhook.svg )] ( https://npm.im/libnpmhook )
4
+ [ ![ license] ( https://img.shields.io/npm/l/libnpmhook.svg )] ( https://npm.im/libnpmhook )
5
+ [ ![ Travis] ( https://img.shields.io/travis/npm/libnpmhook.svg )] ( https://travis-ci.org/npm/libnpmhook )
6
+ [ ![ Coverage Status] ( https://coveralls.io/repos/github/npm/libnpmhook/badge.svg?branch=latest )] ( https://coveralls.io/github/npm/libnpmhook?branch=latest )
2
7
3
8
[ ` libnpmhook ` ] ( https://github.com/npm/libnpmhook ) is a Node.js library for
4
9
programmatically managing the npm registry's server-side hooks.
5
10
6
11
For a more general introduction to managing hooks, see [ the introductory blog
7
12
post] ( https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm ) .
8
13
14
+ ## Table of Contents
15
+
16
+ * [ Example] ( #example )
17
+ * [ Install] ( #install )
18
+ * [ Contributing] ( #contributing )
19
+ * [ API] ( #api )
20
+ * [ hook opts] ( #opts )
21
+ * [ ` add() ` ] ( #add )
22
+ * [ ` rm() ` ] ( #rm )
23
+ * [ ` ls() ` ] ( #ls )
24
+ * [ ` ls.stream() ` ] ( #ls-stream )
25
+ * [ ` update() ` ] ( #update )
26
+
9
27
## Example
10
28
11
29
``` js
@@ -19,17 +37,22 @@ console.log(await hooks.ls('mypkg', {token: 'deadbeef'}))
19
37
20
38
` $ npm install libnpmhook `
21
39
22
- ## Table of Contents
40
+ ### Contributing
23
41
24
- * [ Example] ( #example )
25
- * [ Install] ( #install )
26
- * [ API] ( #api )
27
- * [ hook opts] ( #opts )
28
- * [ ` add() ` ] ( #add )
29
- * [ ` rm() ` ] ( #rm )
30
- * [ ` ls() ` ] ( #ls )
31
- * [ ` ls.stream() ` ] ( #ls-stream )
32
- * [ ` update() ` ] ( #update )
42
+ The npm team enthusiastically welcomes contributions and project participation!
43
+ There's a bunch of things you can do if you want to contribute! The
44
+ [ Contributor Guide] ( https://github.com/npm/cli/blob/latest/CONTRIBUTING.md )
45
+ outlines the process for community interaction and contribution. Please don't
46
+ hesitate to jump in if you'd like to, or even ask us questions if something
47
+ isn't clear.
48
+
49
+ All participants and maintainers in this project are expected to follow the
50
+ [ npm Code of Conduct] ( https://www.npmjs.com/policies/conduct ) , and just
51
+ generally be excellent to each other.
52
+
53
+ Please refer to the [ Changelog] ( CHANGELOG.md ) for project history details, too.
54
+
55
+ Happy hacking!
33
56
34
57
### API
35
58
@@ -68,7 +91,7 @@ See also: [`POST
68
91
##### Example
69
92
70
93
``` javascript
71
- await hooks .add (' ~zkat' , ' https://zkat.tech /api/added' , ' supersekrit' , {
94
+ await hooks .add (' ~zkat' , ' https://example.com /api/added' , ' supersekrit' , {
72
95
token: ' myregistrytoken' ,
73
96
otp: ' 694207'
74
97
})
@@ -78,7 +101,7 @@ await hooks.add('~zkat', 'https://zkat.tech/api/added', 'supersekrit', {
78
101
{ id: ' 16f7xoal' ,
79
102
username: ' zkat' ,
80
103
name: ' zkat' ,
81
- endpoint: ' https://zkat.tech /api/added' ,
104
+ endpoint: ' https://example.com /api/added' ,
82
105
secret: ' supersekrit' ,
83
106
type: ' owner' ,
84
107
created: ' 2018-08-21T20:05:25.125Z' ,
@@ -110,7 +133,7 @@ await hooks.find('16f7xoal', {token: 'myregistrytoken'})
110
133
{ id: ' 16f7xoal' ,
111
134
username: ' zkat' ,
112
135
name: ' zkat' ,
113
- endpoint: ' https://zkat.tech /api/added' ,
136
+ endpoint: ' https://example.com /api/added' ,
114
137
secret: ' supersekrit' ,
115
138
type: ' owner' ,
116
139
created: ' 2018-08-21T20:05:25.125Z' ,
@@ -145,7 +168,7 @@ await hooks.rm('16f7xoal', {
145
168
{ id: ' 16f7xoal' ,
146
169
username: ' zkat' ,
147
170
name: ' zkat' ,
148
- endpoint: ' https://zkat.tech /api/added' ,
171
+ endpoint: ' https://example.com /api/added' ,
149
172
secret: ' supersekrit' ,
150
173
type: ' owner' ,
151
174
created: ' 2018-08-21T20:05:25.125Z' ,
@@ -183,7 +206,7 @@ See also: [`PUT
183
206
##### Example
184
207
185
208
``` javascript
186
- await hooks .update (' 16fxoal' , ' https://zkat.tech /api/other' , ' newsekrit' , {
209
+ await hooks .update (' 16fxoal' , ' https://example.com /api/other' , ' newsekrit' , {
187
210
token: ' myregistrytoken' ,
188
211
otp: ' 694207'
189
212
})
@@ -193,7 +216,7 @@ await hooks.update('16fxoal', 'https://zkat.tech/api/other', 'newsekrit', {
193
216
{ id: ' 16f7xoal' ,
194
217
username: ' zkat' ,
195
218
name: ' zkat' ,
196
- endpoint: ' https://zkat.tech /api/other' ,
219
+ endpoint: ' https://example.com /api/other' ,
197
220
secret: ' newsekrit' ,
198
221
type: ' owner' ,
199
222
created: ' 2018-08-21T20:05:25.125Z' ,
0 commit comments