docs: add changelog and usage instructions

flyingluscas · Feb 1, 2018 · a43ceae · a43ceae
1 parent 37cf85b
commit a43ceae
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,10 @@
+# Changelog
+
+All Notable changes to `steamcmd-docker` will be documented in this file.
+
+Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
+
+## 1.0.0 - 2018-02-01
+
+### Add
+- Dockerfile with SteamCMD installation.
diff --git a/README.md b/README.md
@@ -2,6 +2,22 @@
 
 Just a SteamCMD installation with Docker to run [some of my dedicated servers](https://github.com/flyingluscas/steam-dedicated-servers) ;)
 
+## Install
+
+``` bash
+$ docker pull flyingluscas/steamcmd
+```
+
+## Usage
+
+``` bash
+$ docker run -it --rm flyingluscas/steamcmd steamcmd.sh
+```
+
+## Change log
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
 ## License
 
 The MIT License (MIT). Please see [License File](LICENSE.md) for more information.