Skip to content

Commit a0ebdd6

Browse files
committed
docs(readme): license and npm install
1 parent e52cba5 commit a0ebdd6

File tree

2 files changed

+40
-28
lines changed

2 files changed

+40
-28
lines changed

CONTRIBUTING.md

+5-26
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,9 @@
1-
## @ipfs-shipyard/pinning-service-client@1.0.0
1+
# Contributing guidelines
22

3-
This generator creates TypeScript/JavaScript client that utilizes fetch-api.
3+
IPFS as a project, including js-ipfs and all of its modules, follows the [standard IPFS Community contributing guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md).
44

5-
### Building
5+
We also adhere to the [IPFS JavaScript Community contributing guidelines](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) which provide additional information of how to collaborate and contribute in the JavaScript implementation of IPFS.
66

7-
To build and compile the typescript sources to javascript use:
8-
```
9-
npm install
10-
npm run build
11-
```
7+
We appreciate your time and attention for going over these. Please open an issue on [ipfs/community](https://github.com/ipfs/community) if you have any question.
128

13-
### Publishing
14-
15-
First build the package then run ```npm publish```
16-
17-
### Consuming
18-
19-
navigate to the folder of your consuming project and run one of the following commands.
20-
21-
_published:_
22-
23-
```
24-
npm install @ipfs-shipyard/[email protected] --save
25-
```
26-
27-
_unPublished (not recommended):_
28-
29-
```
30-
npm install PATH_TO_GENERATED_PACKAGE --save
9+
Thank you.

README.md

+35-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1-
## @ipfs-shipyard/pinning-service-client@1.0.0
1+
## IPFS Pinning Service API Client for JS
22

3-
This client was generated using [openapi-generator](https://github.com/OpenAPITools/openapi-generator) from the [ipfs pinning services API spec](https://raw.githubusercontent.com/ipfs/pinning-services-api-spec/main/ipfs-pinning-service.yaml).
3+
This client was generated using [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) from the [IPFS Pinning Service API spec](https://ipfs.github.io/pinning-services-api-spec/).
44

55
You can see the commands used to generate the client in the `gen:fetch` npm script.
66

77
### Usage
88

9+
```
10+
npm install @ipfs-shipyard/pinning-service-client --save
11+
```
12+
913
This client only has a programmatic API at the moment (no CLI). You use it like so:
1014

1115
```ts
@@ -34,3 +38,32 @@ const client = new PinsApi(config)
3438
})()
3539

3640
```
41+
42+
## Developing
43+
44+
### Building
45+
46+
To build and compile the typescript sources to javascript use:
47+
```
48+
npm install
49+
npm run build
50+
```
51+
52+
### Contributing
53+
54+
See [CONTRIBUTING.md](CONTRIBUTING.md).
55+
56+
### Publishing
57+
58+
First build the package then run ```npm publish```
59+
60+
## License
61+
62+
Licensed under either of
63+
64+
* Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / http://www.apache.org/licenses/LICENSE-2.0)
65+
* MIT ([LICENSE-MIT](LICENSE-MIT) / http://opensource.org/licenses/MIT)
66+
67+
Unless you explicitly state otherwise, any contribution intentionally submitted
68+
for inclusion in the work by you, as defined in the Apache-2.0 license, shall
69+
be dual licensed as above, without any additional terms or conditions.

0 commit comments

Comments
 (0)