Skip to content

Commit a4d4120

Browse files
Improve README spelling
Co-authored-by: Timo Furrer <tuxtimo@gmail.com>
1 parent 5e4e836 commit a4d4120

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

README.md

+13-11
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@
77

88
## Why DoCat?
99

10-
When generating static developer documentation using
10+
When generating static documentation using
1111
[mkdocs](https://www.mkdocs.org/), [sphinx](http://www.sphinx-doc.org/en/master/), ...
1212
hosting just one version of the docs might not be enough.
1313
Many users might still use older versions and might need to read
1414
those versions of the documentation.
1515

16-
Docat solves this problem by providing a simple tool that can
17-
host multiple documentation projects with multiple versions.
16+
Docat solves this problem by providing a simple tool that
17+
hosts multiple documentation projects with multiple versions.
1818

19-
*The main design decision with docat was to keep the tool as simpel as possible*
19+
*The main design decision with docat was to keep the tool as simple as possible.*
2020

2121
## Getting started
2222

@@ -40,19 +40,21 @@ Go to [localhost:8000](http://localhost:8000) to view your docat instance:
4040

4141
### Using DoCat
4242

43-
> 🛈 Please note that docat does not provide any way to write documentation
44-
> the tool only hosts documentation.
43+
> 🛈 Please note that docat does not provide any way to write documentation.
44+
> It's sole responsibility is to host documentation.
4545
>
46-
> There are many awesome tools to write developer documenation:
47-
> [mkdocs](https://www.mkdocs.org/), [sphinx](http://www.sphinx-doc.org/en/master/),
48-
> [mdbook](https://rust-lang.github.io/mdBook/) ...
46+
> There are many awesome tools to write documenation:
47+
> - [mkdocs](https://www.mkdocs.org/)
48+
> - [sphinx](http://www.sphinx-doc.org/en/master/)
49+
> - [mdbook](https://rust-lang.github.io/mdBook/)
50+
> - ...
4951
5052

51-
A small tool called [docatl](https://github.com/docat-org/docatl) is provided
53+
A CLI tool called [docatl](https://github.com/docat-org/docatl) is available
5254
for easy interaction with the docat server.
5355
However, interacting with docat can also be done through [`curl`](doc/getting-started.md).
5456

55-
So in order to push documentation (and tag as `latest`) in the folder `docs/` simply run:
57+
To push documentation (and tag as `latest`) in the folder `docs/` simply run:
5658

5759
```sh
5860
docatl push --host http://localhost:8000 ./docs PROJECT VERSION --tag latest

0 commit comments

Comments
 (0)