docs: create initial documentation

Author: Midnighter

docs/.pages

@@ -0,0 +1,5 @@
+nav:
+    - Home: index.md
+    - Issue Tracker: https://github.com/Midnighter/structurizr-python/issues/
+    - Development Plan: https://github.com/Midnighter/structurizr-python/projects/1/
+    - adr

docs/adr/.pages

@@ -0,0 +1,4 @@
+title: Architecture Decision Records
+
+nav:
+    - ...

docs/index.md

@@ -0,0 +1,73 @@
+# Structurizr for Python
+
+A Python client package for the [Structurizr](https://structurizr.com/) cloud
+service and on-premises installation.
+
+## Installation
+
+For the moment, the main installation method is from PyPI, for example, using
+`pip`.
+
+```
+pip install structurizr-python
+```
+
+## Getting Started
+
+There are two starting points. Either you have no Structurizr workspace or you
+have an existing workspace that you want to modify locally.
+
+1. If you don't have a workspace yet, you can sign up for one at
+   [Structurizr](https://structurizr.com/help/getting-started).  Once you have a
+   workspace, take note of its ID, API key, and secret. In order to get started
+   with creating a new workspace, take a look at [the
+   examples](https://github.com/Midnighter/structurizr-python/tree/devel/examples).
+   In particular the
+   [getting-started](https://github.com/Midnighter/structurizr-python/blob/devel/examples/getting_started.py)
+   script will be suitable.
+
+    The `#!python main()` function in each example script creates a more or less involved
+    workspace for you.  When you have created a workspace, it is time to upload
+    it so that you can create diagrams for it.  You will need to create a
+    `#!python StructurizrClient` instance and its settings. The settings can be provided
+    as arguments, be read from environment variables, or be provided in a `.env`
+    file.
+ 
+    ```python
+    from structurizr import StructurizrClient, StructurizrClientSettings
+ 
+    workspace = main()
+    settings = StructurizrClientSettings(
+        workspace_id=1234,
+        api_key='your api key',
+        api_secret='your api secret',
+    )
+    client = StructurizrClient(settings=settings)
+    client.put_workspace(workspace)
+    ```
+ 
+    The example should now be available in your online workspace.
+
+2. In case you already have a comprehensive workspace online, the Python client
+   can help with creating local copies and modifying it.
+
+    ```python
+    from structurizr import StructurizrClient, StructurizrClientSettings
+ 
+    settings = StructurizrClientSettings(
+        workspace_id=1234,
+        api_key='your api key',
+        api_secret='your api secret',
+    )
+    client = StructurizrClient(settings=settings)
+    workspace = client.get_workspace()
+    ```
+ 
+    You can then modify the workspace as you please and upload your new version
+    as shown above.
+
+## Copyright
+
+* Copyright © 2020, Moritz E. Beber.
+* Free software distributed under the [Apache Software License
+  2.0](https://www.apache.org/licenses/LICENSE-2.0).

mkdocs.yml

@@ -2,9 +2,10 @@ site_name: Structurizr-Python
 site_description: A Python client package for the Structurizr cloud service and on-premises installation.
 site_author: Moritz E. Beber
 
-nav:
-  - Home: index.md
-  - Architecture Descision Records: adr
+markdown_extensions:
+  - pymdownx.highlight
+  - pymdownx.superfences
+  - pymdownx.inlinehilite
 
 theme:
   name: material
@@ -17,23 +18,25 @@ theme:
     - navigation.instant
   icon:
     repo: fontawesome/brands/github
+
 plugins:
   - search:
       prebuild_index: true
+  - awesome-pages
 
 extra:
   social:
     - icon: fontawesome/brands/slack
-      link: 'https://join.slack.com/t/structurizr/shared_invite/enQtMzkyMjY1NzMwNTkzLTcyOGI1MTZmNDQwMDQ5YmZlMThiYmU1ZTM2ZWZiMzYwMjVhNmM0OWIwNjFlZTM1YmY3YzU0ZDY2MTA1YTk5Mjg'
+      link: https://join.slack.com/t/structurizr/shared_invite/enQtMzkyMjY1NzMwNTkzLTcyOGI1MTZmNDQwMDQ5YmZlMThiYmU1ZTM2ZWZiMzYwMjVhNmM0OWIwNjFlZTM1YmY3YzU0ZDY2MTA1YTk5Mjg
       name: Join the Structurizr Slack
     - icon: fontawesome/brands/github
-      link: 'https://github.com/Midnighter'
+      link: https://github.com/Midnighter
       name: Moritz on GitHub
     - icon: fontawesome/brands/twitter
-      link: 'https://twitter.com/me_beber'
+      link: https://twitter.com/me_beber
       name: Moritz on Twitter
     - icon: fontawesome/brands/linkedin
-      link: 'https://www.linkedin.com/in/moritz-beber-b597a55a/'
+      link: https://www.linkedin.com/in/moritz-beber-b597a55a/
       name: Moritz on LinkedIn
 
 copyright: Copyright &copy 2020, Moritz E. Beber.