Skip to content

Commit

Permalink
extend readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xrstf committed Dec 1, 2023
1 parent dad2f19 commit 2a50077
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,20 @@ like those available in JSON (numbers, bools, objects, vectors etc.). A statemen
(set! .foo[0] (+ (len .users) 42))
```

## Contents

* [Features](#features)
* [Installation](#installation)
* [Documentation](#documentation)
* [Language Description](docs/language.md)
* [Standard Library](docs/functions/README.md)
* [Usage](#usage)
* [Command Line](#command-line)
* [Embedding](#embedding)
* [Alternatives](#alternatives)
* [Credits](#credits)
* [License](#license)

## Features

* **Safe** evaluation: Rudi is not Turing-complete and so Rudi programs are always guaranteed to
Expand All @@ -40,7 +54,8 @@ like those available in JSON (numbers, bools, objects, vectors etc.). A statemen
## Installation

Rudi is primarily meant to be embedded into other Go programs, but a standalone CLI application,
`rudi`, is also available to test your scripts with. `rudi` can be installed using Git & Go:
`rudi`, is also available to test your scripts with. `rudi` can be installed using Git & Go. Rudi
requires **Go 1.18** or newer.

```bash
git clone https://github.com/xrstf/rudi
Expand All @@ -51,6 +66,13 @@ make build
Alternatively, you can download the [latest release](https://github.com/xrstf/rudi/releases/latest)
from GitHub.

## Documentation

Make yourself familiar with Rudi using the documentation:

* The [Language Description](docs/language.md) describes the Rudi syntax and semantics.
* All built-in functions are described in the [standard library](docs/functions/README.md).

## Usage

### Command Line
Expand Down

0 comments on commit 2a50077

Please sign in to comment.