Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add badges, use latest tag #4

Merged
merged 5 commits into from
Aug 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 1 addition & 8 deletions .github/workflows/publish.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,4 @@ jobs:
${{ secrets.NPM_TOKEN }}
run: |
npm ci
VERSION=$(node -p "require('./packages/${{ matrix.package }}/package.json').version")
if [[ "$VERSION" =~ -rc.[0-9]+$ ]]; then
TAG="next"
else
TAG="latest"
fi
echo "Publishing version $VERSION with tag $TAG..."
just publish-${{ matrix.package }} "--tag ${TAG}" # should fail because this version is already published
just publish-${{ matrix.package }} "--tag latest"
14 changes: 10 additions & 4 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,10 +1,16 @@
.DS_Store
node_modules
.idea
.vscode
packages/client-payments/src/proto/nilchain.ts # generated protobuf codec

node_modules
dist
!packages/client-wasm/dist
docs

packages/client-payments/src/proto/nilchain.ts # generated protobuf codec
packages/fixture/addition_division.nada.bin
packages/fixture/network.json
docs
!packages/client-wasm/dist

.next
examples/nextjs/package-lock.json
examples/react/package-lock.json
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2024 Nillion

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
<!-- @formatter:off -->
# Nillion
# &middot; [Nillion](nillion.com) &middot;

Typescript libraries for interacting with a nillion cluster.
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/facebook/react/blob/main/LICENSE) [![Docs](https://img.shields.io/badge/reference-docs-blue)](https://nillion.pub/client-ts) [![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/NillionNetwork/client-ts)](https://github.com/NillionNetwork/client-ts/issues) [![NPM Version](https://img.shields.io/npm/v/@nillion/client-wasm?label=client-wasm)](https://www.npmjs.com/package/@nillion/client-wasm) [![NPM Version](https://img.shields.io/npm/v/@nillion/client-core?label=client-core)](https://www.npmjs.com/package/@nillion/client-core) [![NPM Version](https://img.shields.io/npm/v/@nillion/client-payments?label=client-payments)](https://www.npmjs.com/package/@nillion/client-payments) [![NPM Version](https://img.shields.io/npm/v/@nillion/client-vms?label=client-vms)](https://www.npmjs.com/package/@nillion/client-vms) [![NPM Version](https://img.shields.io/npm/v/@nillion/client-react-hooks?label=client-react-hooks)](https://www.npmjs.com/package/@nillion/client-react-hooks)

- Source code: [NillionNetwork/client-ts](https://github.com/NillionNetwork/client-ts).
- Api reference docs: [nillion.pub/client-ts](https://nillion.pub/client-ts/).
Typescript libraries for interacting with a nillion cluster.

## Table of Contents

Expand All @@ -31,7 +30,7 @@ Typescript libraries for interacting with a nillion cluster.
1. Add nillion dependencies to a basic React + webpack project. You will need to configure the webpack dev server to ensure the correct HTTP headers are set and a proxy is configured.

```shell
npm i -D @nillion/client-core@next @nillion/client-vms@next @nillion/client-react-hooks@next
npm i -D @nillion/client-core@latest @nillion/client-vms@latest @nillion/client-react-hooks@latest
```

2. Create a client:
Expand Down
Loading
Loading