Skip to content
This repository was archived by the owner on Jan 19, 2022. It is now read-only.

Commit a0fdf7e

Browse files
committedJan 21, 2020
chore: cleanup badges, contrib, readme
1 parent da135b2 commit a0fdf7e

File tree

3 files changed

+40
-421
lines changed

3 files changed

+40
-421
lines changed
 

‎CODE_OF_CONDUCT.md

-148
This file was deleted.

‎CONTRIBUTING.md

-256
This file was deleted.

‎README.md

+40-17
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,29 @@
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)
27

38
[`libnpmhook`](https://github.com/npm/libnpmhook) is a Node.js library for
49
programmatically managing the npm registry's server-side hooks.
510

611
For a more general introduction to managing hooks, see [the introductory blog
712
post](https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm).
813

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+
927
## Example
1028

1129
```js
@@ -19,17 +37,22 @@ console.log(await hooks.ls('mypkg', {token: 'deadbeef'}))
1937

2038
`$ npm install libnpmhook`
2139

22-
## Table of Contents
40+
### Contributing
2341

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!
3356

3457
### API
3558

@@ -68,7 +91,7 @@ See also: [`POST
6891
##### Example
6992

7093
```javascript
71-
await hooks.add('~zkat', 'https://zkat.tech/api/added', 'supersekrit', {
94+
await hooks.add('~zkat', 'https://example.com/api/added', 'supersekrit', {
7295
token: 'myregistrytoken',
7396
otp: '694207'
7497
})
@@ -78,7 +101,7 @@ await hooks.add('~zkat', 'https://zkat.tech/api/added', 'supersekrit', {
78101
{ id: '16f7xoal',
79102
username: 'zkat',
80103
name: 'zkat',
81-
endpoint: 'https://zkat.tech/api/added',
104+
endpoint: 'https://example.com/api/added',
82105
secret: 'supersekrit',
83106
type: 'owner',
84107
created: '2018-08-21T20:05:25.125Z',
@@ -110,7 +133,7 @@ await hooks.find('16f7xoal', {token: 'myregistrytoken'})
110133
{ id: '16f7xoal',
111134
username: 'zkat',
112135
name: 'zkat',
113-
endpoint: 'https://zkat.tech/api/added',
136+
endpoint: 'https://example.com/api/added',
114137
secret: 'supersekrit',
115138
type: 'owner',
116139
created: '2018-08-21T20:05:25.125Z',
@@ -145,7 +168,7 @@ await hooks.rm('16f7xoal', {
145168
{ id: '16f7xoal',
146169
username: 'zkat',
147170
name: 'zkat',
148-
endpoint: 'https://zkat.tech/api/added',
171+
endpoint: 'https://example.com/api/added',
149172
secret: 'supersekrit',
150173
type: 'owner',
151174
created: '2018-08-21T20:05:25.125Z',
@@ -183,7 +206,7 @@ See also: [`PUT
183206
##### Example
184207

185208
```javascript
186-
await hooks.update('16fxoal', 'https://zkat.tech/api/other', 'newsekrit', {
209+
await hooks.update('16fxoal', 'https://example.com/api/other', 'newsekrit', {
187210
token: 'myregistrytoken',
188211
otp: '694207'
189212
})
@@ -193,7 +216,7 @@ await hooks.update('16fxoal', 'https://zkat.tech/api/other', 'newsekrit', {
193216
{ id: '16f7xoal',
194217
username: 'zkat',
195218
name: 'zkat',
196-
endpoint: 'https://zkat.tech/api/other',
219+
endpoint: 'https://example.com/api/other',
197220
secret: 'newsekrit',
198221
type: 'owner',
199222
created: '2018-08-21T20:05:25.125Z',

0 commit comments

Comments
 (0)
This repository has been archived.