mirror of
https://github.com/oceanprotocol-archive/squid-js.git
synced 2024-02-02 15:31:51 +01:00
2.6 KiB
2.6 KiB
squid-js
🦑 JavaScript client library for Ocean Protocol oceanprotocol.com
🐲🦑 THERE BE DRAGONS AND SQUIDS. This is in alpha state and you can expect running into problems. If you run into them, please open up a new issue. 🦑🐲
Table of Contents
Get Started
To start development you need to:
npm i
npm start
This will start a watcher for changes of the code.
Production Build
npm run build
npm releases
For a new patch release, execute on the machine where you're logged into your npm account:
npm run release
In case you have 2FA setup on npm.js, pass a code as One Time Password:
npm run release --otp <yourcode>
Command is powered by release-it
package, defined in the package.json
.
That's what the command does without any user interaction:
- create release commit by updating version in
package.json
- create tag for that release commit
- push commit & tag
- create a new release on GitHub, with change log auto-generated from commit messages
- publish to npm as a new release
If you want to create a minor or major release, use these commands:
npm run release-minor
npm run release-major
License
Copyright 2018 Ocean Protocol Foundation Ltd.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.