diff --git a/docs/index.md b/docs/index.md index fdfd56d..f74adce 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,10 +1,10 @@ -# ES-Progress Bash Library +# Introduction Hi! :cowboy_hat_face: Here you can find the documentation for [_ES-Progress Bash Library_](https://github.com/es-progress/shell){target=\_blank}. -There are some standalone shell scripts, called "binaries" (`bin/`) here :wink: and various shell functions (`lib/`). +This library consist of standalone shell scripts, called "binaries" (`bin/`) here :wink: and various shell functions (`lib/`). Certain functions are useful for interactive use on the command-line, while others makes more sense sourced in scripts. It was written with Bash in mind therefore portability was not a requirement. @@ -12,7 +12,7 @@ First, check the [Installation instructions](install.md). Though most of the "binaries" are intended for standalone use which you can simply download and run, some of them use functions from the library ("lib") and bootstrapping may not be trivial. -Then you can find the reference documentation for each script, function. +Then you can find the reference documentation for each script and function. !!! note diff --git a/mkdocs.yml b/mkdocs.yml index 3c84326..4d0e3c2 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -3,7 +3,7 @@ ## mkdocs config ## ################### --- -site_name: Bash Library of ES-Progress +site_name: ES-Progress Bash Library site_url: https://shell.es-progress.hu site_author: Sandor Semsey copyright: |