From 12234439151b164ddf405a8435760672fc24f1b8 Mon Sep 17 00:00:00 2001
From: Sylvain <sylvaincau31@gmail.com>
Date: Sat, 4 Feb 2023 09:59:14 +0800
Subject: [PATCH] doc: motivation

---
 LICENSE   | 22 ++++++++++++++++++++++
 README.md | 42 ++++++++++++++++++++++++++++--------------
 2 files changed, 50 insertions(+), 14 deletions(-)

diff --git a/LICENSE b/LICENSE
index cfd11b1..c1a8c93 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,28 @@
 MIT License
 
 Copyright (c) 2022-present @sylc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+-------------
+MIT License
+
 Copyright (c) 2020-present the denosaurs team
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
diff --git a/README.md b/README.md
index da5053e..6d3aa19 100644
--- a/README.md
+++ b/README.md
@@ -8,16 +8,26 @@
   <b>Automate semver releases in Deno 🦕</b>
 </p>
 
-A fork of [release](https://github.com/denosaurs/release), by
-[denosaurs](https://github.com/denosaurs), with more config options
+# Motivation
 
-## Installation
+This projects allows to perform automatically tasks required at release time
+like for example:
+
+- Creating a new tag based on existing ones
+- Updating versions number in a file, according to the new tag.
+- Updating links in readme.
+- Creating a changelog.
+- Pushing a release to github.
+
+Most changes are optionals and configurable.
+
+# Installation
 
 ```
 $ deno install -A -f --no-check -n release_up https://deno.land/x/release_up@0.5.0/cli.ts
 ```
 
-## Usage
+# Usage
 
 ```
   Usage:   release_up <release_type> [name]
@@ -44,13 +54,13 @@ $ deno install -A -f --no-check -n release_up https://deno.land/x/release_up@0.5
     --github                            - Enable Github plugin.
     --changelog                         - Enable Changelog plugin.
     --versionFile                       - Enable VersionFile plugin.
-    --regex             <pattern>  - Enable Regex plugin. The regex need to be provided as string.
+    --regex             <pattern>       - Enable Regex plugin. The regex need to be provided as string.
     --dry                               - Dry run, Does not commit any changes.
     --allowUncommitted                  - Allow uncommited change in the repo.
     --debug                             - Enable debug logging.
 ```
 
-## Plugins
+# Plugins
 
 release_up supports local and remote plugins. By default, plugins are **NOT**
 enabled. To enable them, either
@@ -78,7 +88,7 @@ enabled. To enable them, either
 }
 ```
 
-### Baked-in plugins
+## Baked-in plugins
 
 - [github](./doc/doc.md#github): Create a release on Github.
 - [changelog](./doc/doc.md#changelog): Create a changelog based on filtered
@@ -87,7 +97,7 @@ enabled. To enable them, either
 - [versionFile](./plugins/versionFile/mod.ts): Create a `version.json` file with
   the new version number.
 
-### Remote plugins
+## Remote plugins
 
 Plugins can also be defined externally. In that case they must have a "path"
 property in their config. The path can be either a local path or http(s) path.
@@ -95,7 +105,7 @@ property in their config. The path can be either a local path or http(s) path.
 A plugin must contain a default export with the signature defined at
 [./plugins.ts](/plugins.ts)
 
-## Secrets
+# Secrets
 
 release_up uses dotenv to load environment variables. For example for
 interactiong with Github, set a `.env` file with the below
@@ -104,22 +114,26 @@ interactiong with Github, set a `.env` file with the below
 GITHUB_TOKEN=<my secret token>
 ```
 
-## Examples
+# Examples
 
 - [Github Actions worflow](.github/workflows/bump.yml)
 
-## Credits
+# Credits
 
 Big Credits to [denosaurs](https://github.com/denosaurs). This project is a fork
 of [release](https://github.com/denosaurs/release). The current core features
 have been implemented by it.
 
-### Inspiration
+## Inspiration
 
-this project is inspired by node project
+This project is inspired by node project
 [release-it](https://github.com/release-it/release-it)
 
-### Contribution
+## Contribution
 
 Pull request, issues and feedback are very welcome. Code style is formatted with
 deno fmt.
+
+## LICENSE
+
+MIT