summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKevin Gimbel <hallo@kevingimbel.com>2020-02-28 13:36:09 +0100
committerKevin Gimbel <hallo@kevingimbel.com>2020-02-28 13:36:09 +0100
commitdb18db8a706b85b06244ed01d0c34b4bd0ddce63 (patch)
tree4b7dce90a798cb4f5dcfebca0fb453d1027e8ccb
parentd43175cb0dcf22633f76ef57bf56c47c4e6a2284 (diff)
misc: increase version
-rw-r--r--Cargo.toml2
-rw-r--r--README.md39
2 files changed, 40 insertions, 1 deletions
diff --git a/Cargo.toml b/Cargo.toml
index a093bd9..0201e99 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -2,7 +2,7 @@
name = "mktoc"
description = "Generate Table of Contents from Markdown files"
license = "MIT"
-version = "2.0.0"
+version = "2.1.0"
authors = ["Kevin Gimbel <hallo@kevingimbel.com>"]
edition = "2018"
diff --git a/README.md b/README.md
index 011f76c..d9de7fc 100644
--- a/README.md
+++ b/README.md
@@ -4,11 +4,50 @@
![](https://github.com/kevingimbel/mktoc/workflows/Clippy%20check/badge.svg)
<!-- BEGIN mktoc -->
+- [About](#about)
+- [Installation](#installation)
+ - [Cargo](#cargo)
+ - [Binary](#binary)
+- [Usage](#usage)
+ - [Update Markdown file](#update-markdown-file)
- [Command line](#command-line)
- [Environment configuration](#environment-configuration)
- [Performance](#performance)
- [License](#license)
<!-- END mktoc -->
+
+## About
+
+`mktoc` parses markdown files and generates a Table Of Content linking all headlines up to heading level 6 deep, or as specified by command line arguments. A start depth and maximum depth can be specified.
+
+## Installation
+
+`mktoc` can be installed using Cargo, the Rust package manager.
+
+### Cargo
+
+```sh
+$ cargo install mktoc
+```
+#### Update
+
+```
+$ cargo install --force mktoc
+```
+
+### Binary
+
+Binaries are actually not available yet. If you know how releasing binaries with Rust can be implemented, please let me know!
+
+## Usage
+
+### Update Markdown file
+
+Add the following HTML comment into the Markdown file where the Table of Contents should be rendered.
+
+```
+<!-- BEGIN mktoc -->
+<!-- END mktoc -->
```
Everything between those comments will be replaced!