Skip to content

Commit

Permalink
docs(SDK Docs): Updated SDK Docs including Quick Start and Examples
Browse files Browse the repository at this point in the history
Closes #340
  • Loading branch information
ricricucit committed May 17, 2019
1 parent 6f29f29 commit 231735b
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 19 deletions.
36 changes: 24 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,21 +27,22 @@ check out the [develop branch].
- [Æternity's Javascript SDK](#%C3%A6ternitys-javascript-sdk)
- [Disclaimer](#disclaimer)
- [Table of content](#table-of-content)
- [Quick Start](#quick-start)
- [Quick Start](#%E2%9A%A1-quick-start)
- [1. Install the SDK](#1-install-the-sdk)
- [2. Import (a chosen Flavor)](#2-import-a-chosen-flavor)
- [Examples](#examples)
- [3. Create an Account and get some _AEs_](#3-create-an-account-and-get-some-aes)
- [⚡ Examples](#%E2%9A%A1-examples)
- [VueJS (maintained) Examples](#vuejs-maintained-examples)
- [1. Universal Example (_all_ SDK's functionalities)](#1-universal-example-all-sdks-functionalities)
- [2. Wallet Example (_only_ Wallet's functionalities)](#2-wallet-example-only-wallets-functionalities)
- [3. Aepp Example (Aepp <--> Wallet via RPC)](#3-aepp-example-aepp----wallet-via-rpc)
- [CLI - Command Line Client](#cli---command-line-client)
- [Usage Documentation](#usage-documentation)
- [CLI - Command Line Client](#cli---command-line-client)
- [Contributing](#contributing)
- [Change Log](#change-log)
- [License](#license)

## Quick Start
## Quick Start

### 1. Install the SDK
Add the latest `@aeternity/aepp-sdk` release from npmjs.com to your project using one of these commands
Expand All @@ -68,7 +69,14 @@ Import the right [flavor](docs/usage.md). For this example with get the `Univers
import Ae from '@aeternity/aepp-sdk/es/ae/universal' // or other flavor
```

## Examples
### 3. Create an Account and get some _AEs_
You can do many more things now, but you'll probably have to start by:

1. Create an account using the [💻 CLI](#cli---command-line-client)
2. Give yourself some initial _AEs_ using the [🚰 Faucet Aepp](https://faucet.aepps.com/)
3. Enjoy building Aepps 🤓

## ⚡ Examples

### VueJS (maintained) Examples

Expand Down Expand Up @@ -179,21 +187,25 @@ Aepp().then(ae => {
})
```

## Usage Documentation

Generic [Usage Documentation](docs/usage.md).

## CLI - Command Line Client

Install and use our **NodeJS [CLI](https://github.com/aeternity/aepp-cli-js)**.
To quickly test _all_ of Aeternity's blockchain features from your Terminal, you can Install and use our **NodeJS [CLI](https://github.com/aeternity/aepp-cli-js)** by running:

## Usage Documentation
1. `npm i -g @aeternity/aepp-cli` to globally install the CLI
2. `aecly --help` to get a list of possible commands

Generic [Usage Documentation](docs/usage.md).
_eg._ Create an Account:

`aecli account create testWhateverAccountName`

## Contributing

For advanced use, to contribute to development of new versions and to get a deeper understanding of the SDK, it is advised to read the [Contributing](docs/contributing.md) section.
## Contributing

1. [Contribute](docs/contributing.md)
2. [Release](docs/releases.md)
For advanced use, to get a deeper understanding of the SDK or to contribute to its development, it is advised to read the [Contributing Guidelines](docs/contributing.md) section.

## Change Log

Expand Down
4 changes: 2 additions & 2 deletions docs/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,13 @@ targeting Node 0.20.0.

[git-flow strategy]: https://danielkummer.github.io/git-flow-cheatsheet/

## Preparing the Pre-Release (Edgenet)
## Preparing a Pre-Release

If Testnet is not yet targeting the latest Node version (but Edgenet is) you can do a pre-release for the latest `beta` or `alpha` or `next` version, tagging the release as `@next` on npmjs.

To do this, You can follow the steps listed below, while keeping the `alpha` or `beta` or `next` portion in both `CHANGELOG.md` and `package.json` files.

## Preparing the Release (Testnet)
## Preparing a Release (Testnet)

On the release branch, remove the `alpha` (or `beta` or `next`) portion of the `version`
string in `package.json`. Replace the `[Unreleased]` header in the
Expand Down
8 changes: 3 additions & 5 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,21 @@ The recommended approach to using aepp-sdk is to import one of the following _Ae
Factories_ based on the specific use case:

* [@aeternity/aepp-sdk/es/ae/aepp](api/ae/aepp.md): **Web Aepp** development
* * [@aeternity/aepp-sdk/es/ae/aens](api/ae/aens.md): **AENs** development
* [@aeternity/aepp-sdk/es/ae/wallet](api/ae/wallet.md): **Wallet** development
* [@aeternity/aepp-sdk/es/ae/oracle](api/ae/oracle.md): **Oracle** development
* [@aeternity/aepp-sdk/es/ae/contract](api/ae/contract.md): **Contract** development
* [@aeternity/aepp-sdk/es/ae/universal](api/ae/universal.md): **Universal** development (include all SDK features)
* [@aeternity/aepp-sdk/es/ae/universal](api/ae/universal.md): **Universal** development (includes all SDK features)

In order to cater to more specific needs, it is recommended to refer to the
[hacking documentation](hacking.md).

## Testing Networks
When initialising a client, to test, you can choose from 2 URLs:

### 1. **Testnet** (https://sdk-testnet.aepps.com)
### **Testnet** (https://sdk-testnet.aepps.com)
You can use this URL with any releasee on [npmjs](https://www.npmjs.com/package/@aeternity/aepp-sdk). It offers the last stable version of [Node](https://github.com/aeternity/aeternity), used by all of of Aeternity's Dev Tools.

### 2. **Edgenet** (https://sdk-edgened.aepps.com)
You can use this URL with releases tagged as `alpha`, `beta` or `next` on [npmjs](https://www.npmjs.com/package/@aeternity/aepp-sdk). It offers the latest stable version of [Node](https://github.com/aeternity/aeternity), which all of of Aeternity's Dev Tools are going to use in the near future.

## ES Modules (enable Tree-Shaking)

It is generally advised to use ESM (EcmaScript Modules), whenever possible. At
Expand Down

0 comments on commit 231735b

Please sign in to comment.