Skip to content

Commit 0e57c0a

Browse files
authored
chore: improved readme (#42)
* chore: improved readme * chore: added releases link
1 parent 383681a commit 0e57c0a

File tree

2 files changed

+12
-9
lines changed

2 files changed

+12
-9
lines changed

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
### Develop locally
2+
3+
You can update snaphshots with the
4+
`UPDATE_SNAPS=true` variable while running the tests
5+
6+
If you need to update the grammar, you can generate the parser using the `generate-parser.sh` script (you'll need to install the antlr4 command first)

README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
# Numscript CLI
22

3-
[![Go](https://github.com/formancehq/numscript/actions/workflows/checks.yml/badge.svg)](https://github.com/formancehq/numscript/actions/workflows/checks.yml) [![codecov](https://codecov.io/gh/formancehq/numscript/graph/badge.svg?token=njjqGhFQ2p)](https://codecov.io/gh/formancehq/numscript)
3+
[![GitHub Release](https://img.shields.io/github/v/release/formancehq/numscript)](https://github.com/formancehq/numscript/releases)
4+
[![Go Reference](https://pkg.go.dev/badge/github.com/formancehq/numscript.svg)](https://pkg.go.dev/github.com/formancehq/numscript)
5+
[![Go](https://github.com/formancehq/numscript/actions/workflows/checks.yml/badge.svg)](https://github.com/formancehq/numscript/actions/workflows/checks.yml)
6+
[![codecov](https://codecov.io/gh/formancehq/numscript/graph/badge.svg?token=njjqGhFQ2p)](https://codecov.io/gh/formancehq/numscript)
47

5-
Numscript is the DSL used to express financial transaction within the [Formance](https://www.formance.com/) ledger
8+
Numscript is the DSL used to express financial transaction within the [Formance](https://www.formance.com/) ledger.
9+
You can try it in its [online playground](https://playground.numscript.org)
610

711
The CLI in this repo allows you to play with numscript locally, check if there are parsing or logic errors in your numscript files, and run the numscript language server
812

@@ -12,10 +16,3 @@ The language server features include:
1216
- Hover on values
1317
- Detect document symbols
1418
- Go to definition
15-
16-
### Develop locally
17-
18-
You can update snaphshots with the
19-
`UPDATE_SNAPS=true` variable while running the tests
20-
21-
If you need to update the grammar, you can generate the parser using the `generate-parser.sh` script (you'll need to install the antlr4 command first)

0 commit comments

Comments
 (0)