Skip to content
This repository has been archived by the owner on Apr 23, 2024. It is now read-only.

Commit

Permalink
Merge pull request #86 from libotony/dev
Browse files Browse the repository at this point in the history
Dev
  • Loading branch information
libotony authored Apr 8, 2019
2 parents e8e9f51 + 23fca61 commit 17c2065
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 8 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ A web3 adaptor for VeChain [Thor](https://github.com/vechain/thor) RESTful API.
* [Subscriptions support](#subscriptions-support)
* [Notes](#notes)
* [Compatibility](#compatibility)
* [Debugging](#debugging)
* [License](#License)

## Install
Expand Down Expand Up @@ -133,9 +134,9 @@ Here are some most common scenarios:

1. Develop a web application(**Recommend**): `Connex` + [Connex powered VeChain wallets](https://env.vechain.org/)
2. An alternative for web application: `Thorify + Web3` + [Comet](https://env.vechain.org/#comet)
3. Backend service in Node.js: `Thorify+Web3`
4. Contract development in [Truffle](https://truffleframework.com/): `Web3+Web3-Gear`
5. Contract development in [Remix-IDE](https://remix.ethereum.org/): `Web3+Web3-Gear`
3. Backend service in Node.js: `Thorify + Web3`
4. Contract development in [Truffle](https://truffleframework.com/): `Web3 + Web3-Gear`
5. Contract development in [Remix-IDE](https://remix.ethereum.org/): `Web3 + Web3-Gear`

## FAQ

Expand Down Expand Up @@ -166,6 +167,15 @@ Need [email protected] and later to work with subscription module.

Currently, `Thorify` is compatible with `>= [email protected]` and `<= [email protected]`.

## Debugging

```shell
DEBUG=thor:* ts-node index.ts
```

`ts-node index.ts` can be replaced with command to run your code, this example is only for Node.js environment. For more detailed info, please refer to [debug](https://www.npmjs.com/package/debug).


## License

This project is licensed under the MIT license, Copyright (c) 2017 VeChain Foundation. For more information see [LICENSE.md](LICENSE.md).
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "thorify",
"version": "1.1.0",
"version": "1.1.1",
"description": "A web3 adaptor for VeChain Thor RESTful HTTP API.",
"main": "dist/index.js",
"typings": "dist/index.d.ts",
Expand Down

0 comments on commit 17c2065

Please sign in to comment.