mirror of
https://github.com/oceanprotocol/ocean.js.git
synced 2024-11-26 20:39:05 +01:00
ocean-lib-js → ocean.js
This commit is contained in:
parent
5c2cef618e
commit
74f1967b0a
16
README.md
16
README.md
@ -1,11 +1,11 @@
|
||||
[](https://oceanprotocol.com)
|
||||
|
||||
<h1 align="center">ocean-lib-js</h1>
|
||||
<h1 align="center">ocean.js</h1>
|
||||
|
||||
> JavaScript library to privately & securely publish, exchange, and consume data.
|
||||
|
||||
[](https://www.npmjs.com/package/@oceanprotocol/lib)
|
||||
[](https://travis-ci.com/oceanprotocol/ocean-lib-js)
|
||||
[](https://travis-ci.com/oceanprotocol/ocean.js)
|
||||
[](https://codeclimate.com/repos/5f521329523d1e017600e2ae/maintainability)
|
||||
[](https://codeclimate.com/repos/5f521329523d1e017600e2ae/test_coverage)
|
||||
[](https://github.com/prettier/prettier)
|
||||
@ -21,7 +21,7 @@ With it, you can:
|
||||
- **Transfer** data tokens to another owner, and **all other ERC20 actions**
|
||||
using [web3.js](https://web3js.readthedocs.io/en/v1.2.9/web3-eth-contract.html) etc.
|
||||
|
||||
`ocean-lib-js` is part of the [Ocean Protocol](https://oceanprotocol.com) toolset.
|
||||
`ocean.js` is part of the [Ocean Protocol](https://oceanprotocol.com) toolset.
|
||||
|
||||
This is in alpha state and you can expect running into problems. If you run into them, please open up a [new issue](/issues).
|
||||
|
||||
@ -155,13 +155,13 @@ Releases are managed semi-automatically. They are always manually triggered from
|
||||
|
||||
### Production
|
||||
|
||||
From a clean `main` branch you can run any release task bumping the version accordingly based on semantic versioning:
|
||||
From a clean `main` branch you can run the release task bumping the version accordingly based on semantic versioning:
|
||||
|
||||
- To bump a patch version: `npm run release`
|
||||
- To bump a minor version: `npm run release -- minor`
|
||||
- To bump a major version: `npm run release -- major`
|
||||
```bash
|
||||
npm run release
|
||||
```
|
||||
|
||||
Every task does the following:
|
||||
The task does the following:
|
||||
|
||||
- bumps the project version in `package.json`, `package-lock.json`
|
||||
- auto-generates and updates the CHANGELOG.md file from commit messages
|
||||
|
@ -28,15 +28,15 @@
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/oceanprotocol/ocean-lib-js.git"
|
||||
"url": "git+https://github.com/oceanprotocol/ocean.js.git"
|
||||
},
|
||||
"keywords": [],
|
||||
"author": "Ocean Protocol <devops@oceanprotocol.com>",
|
||||
"license": "Apache-2.0",
|
||||
"bugs": {
|
||||
"url": "https://github.com/oceanprotocol/ocean-lib-js/issues"
|
||||
"url": "https://github.com/oceanprotocol/ocean.js/issues"
|
||||
},
|
||||
"homepage": "https://github.com/oceanprotocol/ocean-lib-js#readme",
|
||||
"homepage": "https://github.com/oceanprotocol/ocean.js#readme",
|
||||
"peerDependencies": {
|
||||
"web3": "^1.2.3"
|
||||
},
|
||||
@ -119,7 +119,7 @@
|
||||
"github": {
|
||||
"release": true,
|
||||
"assets": [
|
||||
"dist/lib-js.json"
|
||||
"dist/lib.json"
|
||||
]
|
||||
},
|
||||
"npm": {
|
||||
|
@ -11,7 +11,7 @@ const libJsPackage = require('../package.json')
|
||||
const { description, version } = libJsPackage
|
||||
|
||||
// Setup our paths, relative to project root
|
||||
const outPath = './dist/lib-js.json'
|
||||
const outPath = './dist/lib.json'
|
||||
const files = ['./src/lib.ts']
|
||||
|
||||
// specifically point to tsconfig, otherwise TypeDoc fails
|
||||
|
Loading…
x
Reference in New Issue
Block a user