From 45750c88371ca7f9e5e43924bc8ae7d7959abbe2 Mon Sep 17 00:00:00 2001 From: Yeastplume Date: Thu, 16 May 2019 09:17:54 +0100 Subject: [PATCH] docstring update and provide a bit of a readme (#104) --- README.md | 17 +++++++++++++++++ api/src/owner_rpc.rs | 2 +- 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8f617fadd..284ce94b5 100644 --- a/README.md +++ b/README.md @@ -7,3 +7,20 @@ [![License](https://img.shields.io/github/license/mimblewimble/grin-wallet.svg)](https://github.com/mimblewimble/grin-wallet/blob/master/LICENSE) # Grin Wallet + +This is the reference implementation of [Grin's](https://github.com/mimblewimble/grin) wallet. It consists of 2 major pieces: + +* The Grin Wallet APIs, which are intended for use by Grin community wallet developers. The wallet APIs can be directly linked into other projects or invoked via a JSON-RPC interface. + +* A reference command-line wallet, which provides a baseline wallet for Grin and demonstrates how the wallet APIs should be called. + +# Usage + +To use the command-line wallet, we recommend using the latest release from the [Releases page](https://github.com/mimblewimble/grin-wallet/releases). There are distributions for Linux, MacOS and Windows. + +Full documentation outlining how to use the command line wallet can be found on [Grin's Wiki](https://github.com/mimblewimble/docs/wiki/Wallet-User-Guide) + +# License + +Apache License v2.0 + diff --git a/api/src/owner_rpc.rs b/api/src/owner_rpc.rs index 5e06c7002..8b2f33f61 100644 --- a/api/src/owner_rpc.rs +++ b/api/src/owner_rpc.rs @@ -25,7 +25,7 @@ use crate::Owner; use easy_jsonrpc; /// Public definition used to generate Owner jsonrpc api. -/// * When running `grin-wallet listen` with defaults, the V2 api is available at +/// * When running `grin-wallet owner_api` with defaults, the V2 api is available at /// `localhost:3420/v2/owner` /// * The endpoint only supports POST operations, with the json-rpc request as the body #[easy_jsonrpc::rpc]