Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Clément Salaün <[email protected]>
  • Loading branch information
altitude authored May 7, 2024
1 parent e6d6d78 commit 1a3534f
Showing 1 changed file with 1 addition and 17 deletions.
18 changes: 1 addition & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,14 @@
# Formance Ledger [![test](https://github.com/formancehq/ledger/actions/workflows/main.yml/badge.svg)](https://github.com/formancehq/ledger/actions/workflows/main.yml) [![goreportcard](https://goreportcard.com/badge/github.com/formancehq/ledger)](https://goreportcard.com/report/github.com/formancehq/ledger) [![slack](https://img.shields.io/badge/slack-formance-brightgreen.svg?logo=slack)](https://bit.ly/formance-slack) [![codecov](https://codecov.io/gh/formancehq/ledger/branch/main/graph/badge.svg?token=3PUKLWIKX3)](https://codecov.io/gh/formancehq/ledger)

<p align="center">
<h3 align="center">Formance Ledger is now part of the Formance Stack!</h3>
<p align="center">Checkout the Stack <a href="https://github.com/formancehq/stack">repository</a></p>
</p>

---

Formance Ledger (fka numary) is a programmable financial ledger that provides a foundation for money-moving applications. The ledger provides atomic multi-postings transactions and is programmable in [Numscript](doc:machine-instructions), a built-in language dedicated to money movements. It can be used either as a standalone micro-service or as part of the greater Formance Stack, and will shine for apps that require a lot of custom, money-moving code, e.g:
Formance Ledger is a programmable financial ledger, developed as part of the [Formance Stack](https://github.com/formancehq/stack). It comes with atomic, multi-postings transactions and is programmable in [Numscript](doc:machine-instructions), a built-in DSL dedicated to modelling money movements. It will shine in apps that require complex, money-moving code, e.g:

* E-commerce with complex payments flows, payments splitting, such as marketplaces
* Company-issued currencies systems, e.g. Twitch Bits
* In-game currencies, inventories and trading systems, e.g. Fortnite V-Bucks
* Payment gateways using non-standard assets, e.g. learning credits
* Local currencies and complementary finance

<p align="center">
<img src="https://user-images.githubusercontent.com/1770991/167574970-45d1ab7e-6c57-45a5-9b46-0e849c62f98c.svg" width="400px"/>
</p>

# Getting started

Formance Ledger works as a standalone binary, the latest of which can be downloaded from the [releases page](https://github.com/formancehq/ledger/releases). You can move the binary to any executable path, such as to `/usr/local/bin`. Installations using brew, apt, yum or docker are also [available](https://docs.formance.com/docs/installation-1).
Expand Down Expand Up @@ -65,12 +55,6 @@ You can find the complete Numary documentation at [docs.formance.com](https://do

If you need help, want to show us what you built or just hang out and chat about ledgers you are more than welcome on our [Slack](https://bit.ly/formance-slack) - looking forward to see you there!

# Quick deploy

Want to give a shot to the latest version? You can easily deploy a test instance with Heroku and the button below:

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/formancehq/ledger)

# How to contribute

Want to contribute to the project? Please read the [CONTRIBUTING.md](https://github.com/formancehq/ledger/blob/main/CONTRIBUTING.md) file.
Expand Down

0 comments on commit 1a3534f

Please sign in to comment.