Skip to content

Commit

Permalink
chore: remove gomarkdoc usage for now
Browse files Browse the repository at this point in the history
  • Loading branch information
gfyrag committed Oct 23, 2024
1 parent 6af30c6 commit 2e93443
Show file tree
Hide file tree
Showing 8 changed files with 8 additions and 1,433 deletions.
2 changes: 0 additions & 2 deletions Earthfile
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,12 @@ generate:
FROM core+builder-image
RUN apk update && apk add openjdk11
RUN go install go.uber.org/mock/mockgen@latest
RUN go install github.com/princjef/gomarkdoc/cmd/gomarkdoc@latest
COPY (+sources/*) /src
WORKDIR /src
RUN go generate ./...
SAVE ARTIFACT internal AS LOCAL internal
SAVE ARTIFACT pkg AS LOCAL pkg
SAVE ARTIFACT cmd AS LOCAL cmd
SAVE ARTIFACT README.md AS LOCAL README.md

compile:
FROM +sources
Expand Down
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<<<<<<< Updated upstream
<!-- Code generated by gomarkdoc. DO NOT EDIT -->

# ledger
Expand All @@ -7,6 +8,9 @@ import "github.com/formancehq/ledger"
```

### Formance Ledger
=======
# Formance Ledger
>>>>>>> Stashed changes
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:

Expand All @@ -16,7 +20,7 @@ Formance Ledger \(fka numary\) is a programmable financial ledger that provides
- Payment gateways using non\-standard assets, e.g. learning credits
- Local currencies and complementary finance

### Getting started
## 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 All @@ -33,16 +37,10 @@ curl -X GET http://localhost:3068/quickstart/accounts/bank
curl -X GET http://localhost:3068/quickstart/transactions
```

### Documentation
## Documentation

You can find the complete Numary documentation at \[docs.formance.com\]\(https://docs.formance.com\)

### Community
## Community

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\!

## Index



Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)
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\!
Loading

0 comments on commit 2e93443

Please sign in to comment.