From cff8cadc6ee98a6440452e0d95e87928292de1e7 Mon Sep 17 00:00:00 2001
From: Ed Page <epage@duosecurity.com>
Date: Fri, 28 May 2021 08:33:44 -0500
Subject: [PATCH] docs: Create a Getting Started

---
 README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)

diff --git a/README.md b/README.md
index 3611025..ab44225 100644
--- a/README.md
+++ b/README.md
@@ -19,6 +19,7 @@ Dual-licensed under [MIT](LICENSE-MIT) or [Apache 2.0](LICENSE-APACHE)
 ## Documentation
 
 - [Installation](#install)
+- [Getting Started](#getting-started)
 - [Reference](docs/reference.md)
 - [Comparison with other spell checkers](docs/comparison.md)
 - [Benchmarks](benchsuite/runs)
@@ -36,5 +37,57 @@ Or use rust to install:
 cargo install typos-cli
 ```
 
+## Getting Started
+
+Most commonly, you'll either want to see what typos are available with
+```bash
+typos
+```
+
+Or have them fixed
+```bash
+typos --write-changes
+typos -w
+```
+If there is any ambiguity (multiple possible corrections), `typos` will just report it to the user and move on.
+
+### False-positives
+
+Sometimes, what looks like a typo is intentional, like with people's names, acronyms, or localized content.
+
+To mark an identifier or word as valid, add it your [`_typos.toml`](docs/reference.md) by declaring itself as the valid spelling:
+```toml
+[default.extend-identifiers]
+# *sigh* this just isn't worth the cost of fixing
+AttributeIDSupressMenu = "AttributeIDSupressMenu"
+
+[default.extend-words]
+# Don't correct the surname "Teh"
+teh = "teh"
+```
+
+For localized content, you might want to exclude the entire file
+```toml
+[files]
+extend-exclude = ["localized/*.po"]
+```
+
+### Integrations
+
+`typos` provides several building blocks for custom integrations
+- `-` reads from `stdin`, `--write-changes` will be written to `stdout`
+- `--diff` to provide a diff
+- `--format json` to get jsonlines with exit code 0 on no errors, code 2 on typos, anything else is an error.
+
+Examples:
+```bash
+# Read file from stdin, write corrected version to stdout
+typos - --write-changes
+# Creates a diff of what would change
+typos dir/file --diff
+# Fully programmatic control
+typos dir/file --format json
+```
+
 [Crates.io]: https://crates.io/crates/typos-cli
 [Documentation]: https://docs.rs/typos