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.

Sign up for GitHub

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

Jump to bottom

docs: update readme and remove WIP warning #217

Merged
merged 1 commit into from
Feb 29, 2024
Merged

docs: update readme and remove WIP warning #217

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 2 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,15 +55,9 @@ Loading this module through a script tag will make it's exports available as `Ku
<script src="https://unpkg.com/kubo-rpc-client/dist/index.min.js"></script>
```

## Work In Progress
## Kubo RPC Client

This client is still a work in progress and in active development. Please refer to `ipfs-http-client` for now and only use this package if you are aware of the implications. Follow <https:/ipfs/js-kubo-rpc-client/milestone/1> for tracking when this library is ready for consumption

<h1 align="center">
<a href="https://ipfs.tech"><img width="650px" src="https://ipfs.io/ipfs/QmQJ68PFMDdAsgCZvA1UVzzn18asVcf7HVvCDgpjiSCAse" alt="Kubo RPC Client logo" /></a>
</h1>

<h3 align="center">The JavaScript RPC client library for Kubo.</h3>
<h3 align="center">JavaScript client library for the Kubo RPC API</h3>

<p align="center">
<a href="https://app.element.io/#/room/#ipfs-chatter:ipfs.io"><img src="https://img.shields.io/badge/matrix-%23ipfs%3Amatrix.org-blue.svg?style=flat" /> </a>
Expand All @@ -72,11 +66,9 @@ This client is still a work in progress and in active development. Please refer
</p>

<p align="center">
<a href="https://app.fossa.io/projects/git%2Bgithub.com%2Fipfs%2Fjs-kubo-rpc-client?ref=badge_shield" alt="FOSSA Status"><img src="https://app.fossa.io/api/projects/git%2Bgithub.com%2Fipfs%2Fjs-kubo-rpc-client.svg?type=shield"/></a>
<a href="https://codecov.io/gh/ipfs/js-kubo-rpc-client"><img src="https://img.shields.io/codecov/c/github/ipfs/js-kubo-rpc-client/master.svg?style=flat-square"></a>
<a href="https://bundlephobia.com/result?p=kubo-rpc-client"><img src="https://flat.badgen.net/bundlephobia/minzip/kubo-rpc-client"></a>
<br>
<a href="https://david-dm.org/ipfs/js-kubo-rpc-client"><img src="https://david-dm.org/ipfs/js-kubo-rpc-client.svg?style=flat-square" /></a>
<a href="https:/feross/standard"><img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square"></a>
<a href="https:/RichardLitt/standard-readme"><img src="https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square" /></a>
<a href=""><img src="https://img.shields.io/badge/npm-%3E%3D3.0.0-orange.svg?style=flat-square" /></a>
Expand Down
Loading