Skip to content

Commit 99b5824

Browse files
committed
sdk readmes
1 parent 2ef30bc commit 99b5824

File tree

5 files changed

+20
-4
lines changed

5 files changed

+20
-4
lines changed

sdk/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,10 @@
11
# `sdk`
2-
The FFS SDK is a set of tools for building FFS services. It is generally the entrypoint for researching and building with FFS.
2+
3+
The FFS SDK is a set of tools for building FFS services. It is generally the entry point for researching and building with FFS.
4+
5+
## Contents
6+
7+
- **[`cli`](./cli/README.md)**: the SDK cli suite.
8+
- **[`ffs`](./cli/ffs/README.md)**: the main FFS command line tool.
9+
- **[`ffs-client`](./cli/ffs-client/README.md)**: a client for interacting with FFS.
10+
- **[`ffs-dev`](./cli/ffs-dev/README.md)**: a development tool for FFS.

sdk/cli/ffs-client/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
11
# `ffs-client`
22

33
The command line tool for interacting with live FFS services.
4+
5+
The `ffs-client` relies on the implementation of the following components in each of the sub-protocols in the `[protocol/](../protocol/README.md)` directory:
6+
7+
- `cli/client/` - Command line interface tools for interacting with the protocol
8+
- `clients/eth/` - Ethereum client implementation that handles blockchain interactions

sdk/cli/ffs-dev/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
# `ffs-dev`
2-
The FFS command line tool for those working on active development, typically combines the most FFS command line tools.
2+
3+
The FFS command line tool for those working on active development, typically combines the most FFS command line tools.

sdk/cli/ffs/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
# `ffs`
2-
The main FFS command line tool. This is under specification and development.
2+
3+
The main FFS command line tool.

spec/README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
# `spec`
2-
Spec contains formalizations of the FFS protocol and its components.
2+
3+
Spec contains formalizations of the FFS protocol and its components.

0 commit comments

Comments
 (0)