Skip to content

Commit

Permalink
Finalised version 0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ToJen committed Sep 3, 2018
1 parent 2d42167 commit 0d46cc0
Show file tree
Hide file tree
Showing 3 changed files with 106 additions and 77 deletions.
31 changes: 22 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
Titan CLI
================

<img src="https://s15.postimg.cc/spmnht6zf/Titan_Logo.png" width="100" height="100">

@titan-suite/cli
================

The complete Smart Contract development CLI

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/@titan-suite/cli.svg)](https://npmjs.org/package/@titan-suite/cli)

[![CircleCI](https://circleci.com/gh/titan-suite/cli/tree/master.svg?style=shield)](https://circleci.com/gh/titan-suite/cli/tree/master)

<!-- [![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/titan-suite/cli?branch=master&svg=true)](https://ci.appveyor.com/project/titan-suite/cli/branch/master)
<!-- [![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/titan-suite/cli?branch=master&svg=true)](https://ci.appveyor.com/project/titan-suite/cli/branch/master)
[![Codecov](https://codecov.io/gh/titan-suite/cli/branch/master/graph/badge.svg)](https://codecov.io/gh/titan-suite/cli) -->
[![Downloads/week](https://img.shields.io/npm/dw/@titan-suite/cli.svg)](https://npmjs.org/package/@titan-suite/cli)
[![License](https://img.shields.io/npm/l/@titan-suite/cli.svg)](https://github.com/titan-suite/cli/blob/master/package.json)
[![Chat](http://img.shields.io/badge/titan-suite/Lobby-f81a65.svg)]( https://gitter.im/titan-suite/Lobby )


# Usage
Expand Down Expand Up @@ -56,7 +56,7 @@ Start a new project with a pre-built dApp
- choose a pack from the options
- `titan unpack <name>`

![](https://s15.postimg.cc/cj1jgqrzf/unpack.gif)
![](https://s15.postimg.cc/q8h1wpi5n/unpack.gif)

## `titan compile`

Expand All @@ -79,7 +79,8 @@ Deploy a smart contract to an AION node
- `titan deploy -p 5 path/to/contracts/Example.sol`
_The details of the deployed contract will be stored as `./build/bots/<contractName>.json`_

![](https://s15.postimg.cc/rf02obvob/deploy.gif)

![](https://s15.postimg.cc/5a6al0y3v/deploy.gif)

## `titan lint`

Expand All @@ -100,12 +101,14 @@ Run unit tests
## `titan unlock`

Unlock an account

_You may be prompted to enter an AION address and/or password_

- `titan unlock`
- with the account specified
- `titan unlock -a <0x..>`
- with both the account and password specified
- `titan unlock -a <0x...> -p <pwd>`
_You will be prompted to enter an AION address and password_

![](https://s15.postimg.cc/ulum7y8ej/unlock.gif)

Expand All @@ -114,4 +117,14 @@ _You will be prompted to enter an AION address and password_
Interact with an AION node with an injected `aion-web3` instance
- `titan console`

![](https://s15.postimg.cc/twbtvmpvf/console.gif)
![](https://s15.postimg.cc/twbtvmpvf/console.gif)


# Test

- Create a `titanrc.js` as specified above
- `yarn test`

# Community

Join us on [Gitter](https://gitter.im/titan-suite/Lobby#)
13 changes: 10 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@titan-suite/cli",
"description": "The complete smart contract development tool",
"version": "0.0.3",
"version": "0.1.0",
"author": "Tomisin @ToJen",
"bin": {
"titan": "./bin/run"
Expand Down Expand Up @@ -54,7 +54,14 @@
],
"homepage": "https://titan-suite.com",
"keywords": [
"oclif"
"blockchain",
"titan-suite",
"titan",
"aion",
"smart contract",
"developer tools",
"oclif",
"cli"
],
"license": "Apache-2.0",
"main": "lib/index.js",
Expand All @@ -75,4 +82,4 @@
"version": "oclif-dev readme && git add README.md"
},
"types": "lib/index.d.ts"
}
}

0 comments on commit 0d46cc0

Please sign in to comment.