docs: better usage details on readme
@@ -6,13 +6,19 @@ moov-io/ach
[![Go Report Card](https://goreportcard.com/badge/github.com/moov-io/ach)](https://goreportcard.com/report/github.com/moov-io/ach)
[![Apache 2 licensed](https://img.shields.io/badge/license-Apache2-blue.svg)](https://raw.githubusercontent.com/moov-io/ach/master/LICENSE)
-Package `github.com/moov-io/ach` implements a file reader and writer for parsing Automated Clearing House ([ACH](https://en.wikipedia.org/wiki/Automated_Clearing_House)) files. ACH is the primary method of electronic money movement throughout the United States.
+Package `github.com/moov-io/ach` implements a file reader and writer written in Go along with a HTTP API for creating, parsing and validating Automated Clearing House ([ACH](https://en.wikipedia.org/wiki/Automated_Clearing_House)) files. ACH is the primary method of electronic money movement throughout the United States.
Docs: [docs.moov.io](https://docs.moov.io/en/latest/) | [api docs](https://api.moov.io)
## Project Status
-ACH is under active development but already in production for multiple companies. Please star the project if you are interested in its progress. Right now we are building towards 100% support for the NACHA standards. NACHA issues specifications for Standard Entry Class (SEC) codes, which are designed for various business usecases.
+Moov ACH is under active development but already in production for multiple companies. Please star the project if you are interested in its progress. Right now we are building towards a fully supported HTTP API for ACH file creation and validation. Currently we support generating and parsing all Standard Entry Class (SEC) codes.
+
+## Usage
+
+### Go library
+
+`github.com/moov-io/ach` offers a Go based ACH file reader and writer. To get started checkout a specific example:
<details>
<summary>Supported Standard Entry Class (SEC) codes</summary>
@@ -46,13 +52,12 @@ ACH is under active development but already in production for multiple companies
</details>
-## HTTP API
+### HTTP API
-The `ach` project also offers an HTTP and JSON API for creating and editing files. If you're using Go the `ach.File` type can be used, otherwise just send properly formatted JSON. We have an [example JSON file](test/testdata/ppd-valid.json), but each SEC type will generate differnet JSON.
+`github.com/moov-io/ach/server` offers a HTTP and JSON API for creating and editing files. If you're using Go the `ach.File` type can be used, otherwise just send properly formatted JSON. We have an [example JSON file](test/testdata/ppd-valid.json), but each SEC type will generate differnet JSON.
Examples: [Go](examples/http/main.go) | [Ruby](https://github.com/moov-io/ruby-ach-demo)
-- [Submit plaintext ACH file for validation](#) (...) # TODO(adam)
- [Create an ACH file for a payment and get the raw file](https://github.com/moov-io/ruby-ach-demo)
## Getting Started
