Skip to content
This repository was archived by the owner on Jun 4, 2026. It is now read-only.

Commit 2dab7b0

Browse files
committed
docs: add readme
1 parent ba5c314 commit 2dab7b0

1 file changed

Lines changed: 39 additions & 1 deletion

File tree

README.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,39 @@
1-
# rail-msg-sql
1+
# moov-io/rail-msg-sql
2+
===
3+
4+
[![GoDoc](https://godoc.org/github.com/moov-io/rail-msg-sql?status.svg)](https://godoc.org/github.com/moov-io/rail-msg-sql)
5+
[![Build Status](https://github.com/moov-io/rail-msg-sql/workflows/Go/badge.svg)](https://github.com/moov-io/rail-msg-sql/actions)
6+
[![Go Report Card](https://goreportcard.com/badge/github.com/moov-io/rail-msg-sql)](https://goreportcard.com/report/github.com/moov-io/rail-msg-sql)
7+
[![Apache 2 licensed](https://img.shields.io/badge/license-Apache2-blue.svg)](https://raw.githubusercontent.com/moov-io/rail-msg-sql/master/LICENSE)
8+
9+
moov-io/rail-msg-sql is an experimental project to offer SQL access over raw payment rail messages. The initial rail/message support is for ACH files, but we plan to support additional rails and messages.
10+
11+
## Project Status
12+
13+
This project is an experiment within Moov. Please star the project if you are interested in its progress. We are looking for community feedback so please try out our code or give us feedback!
14+
15+
If you believe you have identified a security vulnerability please responsibly report the issue as via email to security@moov.io. Please do not post it to a public issue tracker.
16+
17+
## Getting Started
18+
19+
Download the [docker image](https://hub.docker.com/r/moov/rail-msg-sql) or source code and run rail-msg-sql with the [example config](./examples).
20+
21+
## Getting Help
22+
23+
channel | info
24+
------- | -------
25+
Twitter [@moov](https://twitter.com/moov) | You can follow Moov.io's Twitter feed to get updates on our project(s). You can also tweet us questions or just share blogs or stories.
26+
[GitHub Issue](https://github.com/moov-io/rail-msg-sql/issues) | If you are able to reproduce a problem please open a GitHub Issue under the specific project that caused the error.
27+
[moov-io slack](https://slack.moov.io/) | Join our slack server to have an interactive discussion about the development of the project.
28+
29+
## Supported and Tested Platforms
30+
31+
- 64-bit Linux (Ubuntu, Debian), macOS, and Windows
32+
33+
## Contributing
34+
35+
Yes please! Please review our [Code of Conduct](https://github.com/moov-io/ach/blob/master/CODE_OF_CONDUCT.md) to get started!
36+
37+
## License
38+
39+
Apache License 2.0 See [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)