update README

pull/94/head
iwilltry42 5 years ago
parent 6060d46ab2
commit c257be4960
  1. 7
      README.md
  2. 4
      docs/documentation.md

@ -46,6 +46,11 @@ Example Workflow: Create a new cluster and use it with `kubectl`
3. execute some commands like `kubectl get pods --all-namespaces`
4. `k3d delete` to delete the default cluster
### Exposing Services
If you want to access your services from the outside (e.g. via Ingress), you need to map the ports (e.g. port 80 for Ingress) using the `--publish` flag (or aliases).
Check out the [examples here]((docs/examples.md)).
## What now?
Find more details under the following Links:
@ -58,4 +63,4 @@ Find more details under the following Links:
1. Join the Rancher community on slack via [slack.rancher.io](https://slack.rancher.io/)
2. Go to [rancher-users.slack.com](https://rancher-users.slack.com) and join our channel #k3d
3. Start chatting
3. Start chatting

@ -5,6 +5,7 @@
```shell
COMMANDS:
check-tools, ct Check if docker is running
shell Start a subshell for a cluster
create, c Create a single- or multi-node k3s cluster in docker containers
delete, d, del Delete cluster
stop Stop cluster
@ -19,7 +20,6 @@ GLOBAL OPTIONS:
--version, -v print the version
```
## Compatibility with `k3s` functionality/options
... under construction ...
... under construction ...

Loading…
Cancel
Save