From 2b1cf565bad3b586ac9d92ab79213a324a1f5894 Mon Sep 17 00:00:00 2001 From: ascandone Date: Wed, 19 Feb 2025 13:38:43 +0100 Subject: [PATCH 1/2] chore: improved readme --- CONTRIBUTING.md | 6 ++++++ README.md | 15 ++++++--------- 2 files changed, 12 insertions(+), 9 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..932287fd --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,6 @@ +### Develop locally + +You can update snaphshots with the +`UPDATE_SNAPS=true` variable while running the tests + +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) diff --git a/README.md b/README.md index 3ac599e5..e3c0e457 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,12 @@ # Numscript CLI -[![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) +![GitHub Release](https://img.shields.io/github/v/release/formancehq/numscript) +[![Go Reference](https://pkg.go.dev/badge/github.com/formancehq/numscript.svg)](https://pkg.go.dev/github.com/formancehq/numscript) +[![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) -Numscript is the DSL used to express financial transaction within the [Formance](https://www.formance.com/) ledger +Numscript is the DSL used to express financial transaction within the [Formance](https://www.formance.com/) ledger. +You can try it in its [online playground](https://playground.numscript.org) 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 @@ -12,10 +16,3 @@ The language server features include: - Hover on values - Detect document symbols - Go to definition - -### Develop locally - -You can update snaphshots with the -`UPDATE_SNAPS=true` variable while running the tests - -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) From b8eb61c1f3f2e85b24649edf49098447f7a7d127 Mon Sep 17 00:00:00 2001 From: ascandone Date: Wed, 19 Feb 2025 13:41:27 +0100 Subject: [PATCH 2/2] chore: added releases link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e3c0e457..eef67836 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Numscript CLI -![GitHub Release](https://img.shields.io/github/v/release/formancehq/numscript) +[![GitHub Release](https://img.shields.io/github/v/release/formancehq/numscript)](https://github.com/formancehq/numscript/releases) [![Go Reference](https://pkg.go.dev/badge/github.com/formancehq/numscript.svg)](https://pkg.go.dev/github.com/formancehq/numscript) [![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)