Take a clarifying pass at README
All checks were successful
continuous-integration/drone/push Build is passing

This commit is contained in:
Luke Murphy 2020-04-27 16:27:23 +02:00
parent 837de64be9
commit d2d548b166
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC

View File

@ -24,6 +24,7 @@ any financial support from RedHat or Hetzner Cloud for this work.
## Usage ## Usage
You need to expose a `HCLOUD_TOKEN` environment variable in your environment. You need to expose a `HCLOUD_TOKEN` environment variable in your environment.
Find out more about how to get one of those [over here](https://docs.hetzner.cloud/#overview-authentication). Find out more about how to get one of those [over here](https://docs.hetzner.cloud/#overview-authentication).
```bash ```bash
@ -46,7 +47,7 @@ dependency:
driver: driver:
name: hetznercloud name: hetznercloud
platforms: platforms:
- name: my-instance-name - name: instance
server_type: cx11 server_type: cx11
image: debian-10 image: debian-10
provisioner: provisioner:
@ -71,7 +72,7 @@ $ export MOLECULE_NO_LOG=False # not so verbose, helpful
$ export MOLECULE_DEBUG=True # very verbose, last ditch effort $ export MOLECULE_DEBUG=True # very verbose, last ditch effort
``` ```
## Only use the `molecule.yml` for configuration ## Only use `molecule.yml` for configuration
It is being worked on that it is possible to remove all the files except the It is being worked on that it is possible to remove all the files except the
`molecule.yml` scenario file in your scenario directory. This is useful when `molecule.yml` scenario file in your scenario directory. This is useful when
@ -109,16 +110,16 @@ The [LGPLv3](https://www.gnu.org/licenses/lgpl-3.0.en.html) license.
This is all done on our [drone.autonomic.zone](https://drone.autonomic.zone/autonomic-cooperative/molecule-hetznercloud) setup. This is all done on our [drone.autonomic.zone](https://drone.autonomic.zone/autonomic-cooperative/molecule-hetznercloud) setup.
Unit tests and such. ### Unit
```bash ```bash
$ pip install tox $ pip install tox
$ tox -v $ tox -v
``` ```
Integration tests. ### Integration
(Only doable by [Autonomic Cooperative](https://autonomic.zone/) members.) Only doable by [Autonomic Cooperative](https://autonomic.zone/) members.
```bash ```bash
$ sudo apt install -y direnv $ sudo apt install -y direnv