Skip to content

Commit 83c213b

Browse files
authored
Updated README to point to developer docs
1 parent 53f6248 commit 83c213b

File tree

1 file changed

+3
-37
lines changed

1 file changed

+3
-37
lines changed

README.md

+3-37
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,5 @@
1-
# 5min-idp - Quick Humanitec Demo
1+
# Five-minute IDP
22

3-
Your Humanitec Demo Environment in less than 3 minutes.
3+
Your Humanitec Internal Developer Platform (IDP) demo environment in less than five minutes.
44

5-
Required:
6-
7-
* [humctl](https://developer.humanitec.com/platform-orchestrator/cli/)
8-
* docker
9-
10-
## Usage
11-
12-
### Configure
13-
14-
```bash
15-
humctl login
16-
export HUMANITEC_ORG=MY_ORG
17-
```
18-
19-
### Run
20-
21-
* Start the toolbox
22-
23-
```bash
24-
docker run --rm -it -h 5min-idp --name 5min-idp --pull always \
25-
-e HUMANITEC_ORG \
26-
-v hum-5min-idp:/state \
27-
-v $HOME/.humctl:/root/.humctl \
28-
-v /var/run/docker.sock:/var/run/docker.sock \
29-
--network bridge \
30-
ghcr.io/humanitec-tutorials/5min-idp
31-
```
32-
33-
* Use it!
34-
35-
```bash
36-
./0_install.sh # install & connect a local cluster powered by kind
37-
./1_demo.sh # deploy your 1st score workload
38-
./2_cleanup.sh # cleanup everything
39-
```
5+
The material in this project provides the tooling for the ["Five-minute IDP"](https://developer.humanitec.com/introduction/getting-started/the-five-minute-idp/) getting started guide in the Humanitec developer docs. Please refer to that guide for usage instructions.

0 commit comments

Comments
 (0)