WARNING: js-textile-threads-encoding has been deprecated. See js-threads for a complete implementation.

Threads Encoding (js-textile-threads-encoding)

Encoding/decoding tools for Textile Threads in Typescript/Javascript

Check out our docs for more about Textile.

Join us on our public Slack channel for news, discussions, and status updates. Check out our blog for the latest posts and announcements.

Table of Contents

• Background
• Install
• Usage
• API
• Maintainers
• Contributing
• License

Background

TODO

Install

Node

This is a pre-release package. To install, please git clone locally and test from there. Once the package has been released to npm, the following will be the primary means of installing the library.

npm i @textile/threads-encoding

Usage

Typescript

// TODO

Nodejs

// TODO

Browser

<script>
window.addEventListener('load', function () {
    async function main() {
    // TODO
    }
    main()
})
</script>
<script type="text/javascript" src="encoding.min.js"></script>

There are also several useful examples included in the tests folder of this repo.

API

See https://textileio.github.io/js-textile-threads-encoding

Maintainers

Carson Farmer

Contributing

See the contributing file!

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT (c) 2019 Textile