From 035a3c6dc7062f71044575d24ebd17f6b2beb9e7 Mon Sep 17 00:00:00 2001 From: Andy Grunwald Date: Sun, 16 Feb 2020 13:14:15 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9A=20Correct=20a=20few=20grammar=20pi?= =?UTF-8?q?eces=20in=20the=20README=20(#19)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Correct a few grammar pieces in the README * Revert "Have you got any questions?" to "Got questions?" Co-authored-by: Franck Nijhof --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 5f38753..881b268 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ ## About -Bashio is an bash function library for use with Home Assistant add-ons. +Bashio is a bash function library for use with Home Assistant add-ons. It contains a set of commonly used operations and can be used to be included in add-ons to reduce code duplication across add-ons and @@ -27,7 +27,7 @@ Main goals: - Reduce the number of operations needed in add-ons. - Reduce the amount of code needed in add-ons. - Make add-on code more readable. -- Providing an trusted and tested code base. +- Providing a trusted and tested code base. Quicker add-on development, by allowing you to focus on the add-on logic instead of other things. @@ -49,16 +49,16 @@ Currently available base images: - [Official Home Assistant Raspbian Docker Base Image][home-assistant-base] - [Official Home Assistant Ubuntu Docker Base Image][home-assistant-base] -Using those images as the base for your Home Assistant add-on, will provide this +Using those images as the base for your Home Assistant add-on will provide this function library out of the box. Our base images are updated frequently and -provides the minimal needed base image for a great add-on. +provide the minimal needed base image for a great add-on. If you want to add Bashio to your own images, please take a look at the Dockerfile of the above base images to see how they are added at build time. ## Configuration -Configuring an Bash script to use the Bashio library is fairly easy. Simply +Configuring a Bash script to use the Bashio library is fairly easy. Simply replace the shebang of your script file, from `bash` to `bashio`. Before example: @@ -86,15 +86,15 @@ bashio::log.info "${USERNAME}" ## Functions -Bashio has more then 250+ functions available: communicating with +Bashio has more than 250+ functions available: communicating with the Supervisor API, Have I Been Pwned, file system, logging, configuration handling and a lot more! -The best way to get around, would be by looking at the different modules +The best way to get around would be by looking at the different modules available in the [`lib`](lib) folder. Each module has its own file, and each -function has been documented inside the code base. +function has been documented inside the codebase. -Further more, Bashio is used by the +Furthermore, Bashio is used by the [Home Assistant Community Add-ons project][repository], those add-ons will be a great resource of practical examples.