From dabf1caf492e21d9bc4d6f8c41db35972e054fa9 Mon Sep 17 00:00:00 2001 From: Marco Sampellegrini Date: Fri, 8 Sep 2023 09:12:10 +0200 Subject: [PATCH] Update README. --- README.md | 24 ++++++++++++++++++------ 1 file changed, 18 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 0cc23db..d16c805 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,10 @@ ![Borgo sits between Go and Rust](https://raw.githubusercontent.com/borgo-lang/borgo-lang.github.io/main/borgo.jpg) +--- + +![build](https://github.com/borgo-lang/borgo/actions/workflows/ci.yml/badge.svg) + I want a language for writing applications that is more expressive than Go but less complex than Rust. @@ -14,7 +18,7 @@ existing Go packages. Borgo syntax is similar to Rust, with optional semi-colons. -## Tutorial +# Tutorial Check out the **[online playground](https://borgo-lang.github.io/)** for a tour of the language. @@ -25,9 +29,9 @@ You can also take a look at test files for working Borgo code: - [infer-expr.md](compiler/test/infer-expr.md) - [infer-file.md](compiler/test/infer-file.md) -## Features +# Features -**Algebraic data types and pattern matching** +## Algebraic data types and pattern matching ```rust use fmt @@ -45,7 +49,9 @@ let msg = match state { } ``` -**`Option` instad of `nil`** +--- + +## `Option` instad of `nil` ```rust // import packages from Go stdlib @@ -60,7 +66,9 @@ match key { } ``` -**`Result` instad of multiple return values** +--- + +## `Result` instad of multiple return values ```rust use fmt @@ -76,7 +84,9 @@ fn makeRequest() -> Result { } ``` -**Error handling with `?` operator** +--- + +## Error handling with `?` operator ```rust use fmt @@ -103,6 +113,8 @@ fn copyFile(src: string, dst: string) -> Result<(), error> { } ``` +--- + ## Guessing game example Small game from the Rust book, implemented in Borgo.