DEPRECATION NOTICE: Textile's hosted Hub infrastructure will be taken off-line on January 9th, 2023. At this time, all ThreadDB and Bucket data will no longer be available, and will subsequently be removed. See https://github.com/textileio/textile/issues/578 for further details.
JS-Textile
Typescript/Javascript libs for interacting with Textile APIs.
Go to the docs for more about Textile.
Join us on our public Discord server for news, discussions, and status updates.
Table of Contents
Install
npm install @textile/hub
Usage
We are shutting down our hosted Hub infrastructure. Please see this deprecation notice for details.
@textile/hub
provides access to Textile APIs in apps based on API Keys. For details on getting keys, see textileio/textile or join our Discord.
Contributing
This project is no longer under active development. If you'd like to get something change/fixed/updated, here are some ways to make that happen:
- Ask questions! We'll try to help. Be sure to drop a note (on the above issue) if there is anything you'd like to work on and we'll update the issue to let others know. Also get in touch on Slack.
- Open issues, file issues, submit pull requests!
- Perform code reviews. More eyes will help a) speed the project along b) ensure quality and c) reduce possible future bugs.
- Take a look at the code. Contributions here that would be most helpful are top-level comments about how it should look based on your understanding. Again, the more eyes the better.
- Add tests. There can never be enough tests.
Building docs
On mac, docs require gnu-sed.
brew install gnu-sed
Follow brew info gnu-sed
instructions to make it default sed.
Install Docusaurus
cd website
npm install
cd ..
Update markdown
npm run docs
Run docs server
npm run serve:docs
Changelog
Changelog is published to Releases.
License
MIT