From 3ebea48a8eb82bc245a7bf0bc7cc1d3e98005497 Mon Sep 17 00:00:00 2001 From: Matthias Endler Date: Fri, 22 Feb 2019 14:05:09 +0100 Subject: [PATCH] Fix grammar and typos --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 5ddfabf..b7092d6 100644 --- a/README.md +++ b/README.md @@ -2,27 +2,27 @@ butler

-Butler is an automatation tool to scaffold new projects in only a few seconds. +Butler is an automation tool to scaffold new projects in only a few seconds. We provide a powerful interactive cli. When you create a project template you can create a [`Survey`](/docs/templateSurveys.md). Surveys are used to collect -informations from the users to generate individual templates. Beside -templating we also plan to integrate common commands for popular Project Management +information from users to generate individual templates. Beside +templating, we also plan to integrate common commands for popular Project Management Tools like Jira, Confluence in Butler. -> Bootstraping projects should be fun! +> Bootstrapping projects should be fun! ## Features - ✔︎ Template Surveys - ✔︎ Conditional files and folders - ✔︎ After hooks for post-processing -- :sparkles: **Maintanance:** Auto Update, Distributed configs +- :sparkles: **Maintenance:** Auto Update, Distributed configs - :star2: **Confluence:** Create spaces with preconfigured page tree ## Principles - Project Templates are simple git repositories - Everything is a template you don't have to deal with `/template` directories or `.tmpl` files -- Required informations are asked during the bootstrapping process +- Required information is asked during the bootstrapping process ## Usage @@ -45,7 +45,7 @@ or `.tmpl` files - **Create Project:** This command will create a new project based on the selected template. - **Create Git Hooks:** This command will install all selected hooks. - **Create Confluence Space:** This command will create a public or private confluence space based on the selected template. -- **Maintanance:** +- **Maintenance:** - **Dump config:** Prints the final butler config in the terminal. - **Auto Update:** This command will update Butler to the latest version. - **Report a bug:** This command will open a new Github issue. @@ -56,7 +56,7 @@ or `.tmpl` files - Butler is able to update itself. The latest Github release is used. - Stay up-to-date with new templates without to update your config manually just set the environment variable `BUTLER_CONFIG_URL` to [butler.yml on master](https://raw.githubusercontent.com/netzkern/butler/master/butler.yml) and both configs are merged. -## What Butler template looks like ? +## What Butler template looks like? [example-project-template](https://github.com/netzkern/example-project-template)