From 63ebd6beb86b3e6df06cc1db47aeb6c3e67207d5 Mon Sep 17 00:00:00 2001 From: Ruidy Date: Fri, 25 Mar 2022 10:39:25 -0400 Subject: [PATCH] update docs --- README.md | 16 +++++++--------- docs/content/_index.md | 8 +++++--- docs/content/usage/start.md | 9 +++------ 3 files changed, 15 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index fc2d66c..a80f79c 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,15 @@ # Underscore ![License](https://img.shields.io/github/license/rjNemo/underscore?style=for-the-badge) -![Go version](https://img.shields.io/github/go-mod/go-version/rjNemo/underscore?style=for-the-badge) -![test coverage](https://img.shields.io/codecov/c/github/rjNemo/underscore?style=for-the-badge) +![Go version](https://img.shields.io/github/go-mod/go-version/rjNemo/underscore?style=for-the-badge&logo=go) +![Go report](https://goreportcard.com/badge/github.com/rjNemo/underscore?style=for-the-badge) +![test coverage](https://img.shields.io/codecov/c/github/rjNemo/underscore?style=for-the-badge&logo=codecov) ![underscore](https://socialify.git.ci/rjNemo/underscore/image?description=1&descriptionEditable=Useful%20functional%20programming%20helpers%20for%20Go%201.18%20and%20beyond&font=Raleway&language=1&logo=https%3A%2F%2Fraw.githubusercontent.com%2FrjNemo%2Funderscore%2Fmain%2Fdocs%2Fstatic%2Flogo.png&owner=1&pattern=Floating%20Cogs&stargazers=1&theme=Light) `underscore` is a `Go` library providing useful functional programming helpers without extending any built-in objects. -It is mostly a port from the `underscore.js` library based on generics brought by `go1.18`. +It is mostly a port from the `underscore.js` library based on generics brought by `Go 1.18`. ## Usage @@ -50,13 +51,10 @@ purposes. ### Prerequisites -You need at least `go1.18` for development. The project is shipped with a [Dockerfile](Dockerfile) based on `go1.18`. If -you prefer local development, at the moment the easiest way to do it: +You need at least `go1.18` for development. The project is shipped with a [Dockerfile](Dockerfile) based on `go1.18`. -```shell script -go install golang.org/dl/go1.18beta1@latest -go1.18beta1 download -``` +If you prefer local development, navigate to the [official +download page](https://go.dev/dl/) and install version `1.18` or beyond. ### Installing diff --git a/docs/content/_index.md b/docs/content/_index.md index 346f7f0..215a780 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -2,11 +2,13 @@ title: underscore --- +![License](https://img.shields.io/github/license/rjNemo/underscore?style=for-the-badge) +![Go version](https://img.shields.io/github/go-mod/go-version/rjNemo/underscore?style=for-the-badge&logo=go) +![Go report](https://goreportcard.com/badge/github.com/rjNemo/underscore?style=for-the-badge) +![test coverage](https://img.shields.io/codecov/c/github/rjNemo/underscore?style=for-the-badge&logo=codecov) + ![underscore](https://socialify.git.ci/rjNemo/underscore/image?description=1&font=Raleway&language=1&logo=https%3A%2F%2Fgithub.com%2FrjNemo%2Funderscore%2Fblob%2Fmain%2Fdocs%2Fstatic%2Flogo.png%3Fraw%3Dtrue&name=1&pattern=Floating%20Cogs&theme=Light) -![License](https://img.shields.io/github/license/rjNemo/underscore?style=for-the-badge) -![Go version](https://img.shields.io/github/go-mod/go-version/rjNemo/underscore?style=for-the-badge) -![test coverage](https://img.shields.io/codecov/c/github/rjNemo/underscore?style=for-the-badge) `underscore` is a `Go` library providing useful functional programming helpers without extending any built-in objects. diff --git a/docs/content/usage/start.md b/docs/content/usage/start.md index 8b79bab..aede265 100644 --- a/docs/content/usage/start.md +++ b/docs/content/usage/start.md @@ -42,13 +42,10 @@ purposes. ### Prerequisites You need at least `go1.18` for development. The project is shipped with -a [Dockerfile](https://github.com/rjNemo/underscore/tree/main/Dockerfile) based on `go1.18`. If you prefer local -development, at the moment the easiest way to do it: +a [Dockerfile](https://github.com/rjNemo/underscore/tree/main/Dockerfile) based on `go1.18`. -```shell -go install golang.org/dl/go1.18beta1@latest -go1.18beta1 download -``` +If you prefer local development, navigate to the [official +download page](https://go.dev/dl/) and install version `1.18` or beyond. ### Installing