Skip to content
Typescript/Javascript implementation of Textile's Threads Protocol
TypeScript JavaScript
Branch: master
Clone or download
carsonfarmer chore: release/publish
 - @textile/threads-core@0.0.3-alpha.0
 - @textile/threads-encoding@0.0.3-alpha.0
 - @textile/threads-examples@0.0.3-alpha.0
 - @textile/threads-service-client@0.0.3-alpha.0
 - @textile/threads-service@0.0.3-alpha.0
Latest commit 83608fb Feb 11, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Create PR template Feb 9, 2020
packages chore: release/publish Feb 12, 2020
.commitlintrc.json chore(ci): adds circleci + commitlint Dec 19, 2019
.editorconfig init: let's get this started Dec 18, 2019
.eslintignore feat: update ignore dot files Feb 11, 2020
.eslintrc.json
.gitignore feat: update ignore dot files Feb 11, 2020
.mocharc.json init: let's get this started Dec 18, 2019
.prettierignore init: let's get this started Dec 18, 2019
.prettierrc.json init: let's get this started Dec 18, 2019
CODE-OF-CONDUCT.md
CODEOWNERS
CONTRIBUTING.md init: let's get this started Dec 18, 2019
LICENSE init: let's get this started Dec 18, 2019
README.md fix: linter fixes Feb 11, 2020
lerna.json chore: customize release msg Feb 12, 2020
package-lock.json fix: adds nojekyll file to docs output Feb 5, 2020
package.json feat: move browser tests to package level Feb 11, 2020
tsconfig.json init: let's get this started Dec 18, 2019
typedoc.json
webpack.test.js

README.md

Textile's Threads Protocol (js-threads)

Made by Textile Chat on Slack GitHub license GitHub package.json version npm (scoped) Release docs standard-readme compliant lerna

Typescript implementation of Textile's Threads Protocol

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

TODO

Install

// TODO

Usage

// TODO

There are also several useful examples included as tests in the sub-packages of this repo.

Developing

This mono-repo is made up of several sub-packages, all managed by lerna. You shouldn't have to do anything special to get started, however, here are a few steps that will make it easier to develop new functionality locally.

git clone git@github.com:textileio/js-threads.git
cd js-threads
npm i
lerna bootstrap

Then you are pretty much ready to go. You can run tests for all sub-packages from the root directory:

npm test
# Or run the node- or browser-specific tests separately
npm run test:node
npm run test:browser

Similarly, you can compile the Typescript-based sub-packages to Javascript all at once:

npm run build

See the lerna docs for other things you can do to make working across multiple packages easier.

API

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

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-2010 Textile

You can’t perform that action at this time.