Skip to content

Commit 224c2f9

Browse files
committed
Updating README
1 parent db2ba49 commit 224c2f9

File tree

1 file changed

+18
-4
lines changed

1 file changed

+18
-4
lines changed

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,26 @@ Or to run from the repository:
5555

5656
The above starts a shell with uPlaybook available to run.
5757

58+
## Getting Started
59+
60+
You can create a skeleton playbook, in the uplaybook git checkout, with:
61+
62+
up new-uplaybook my-test-playbook
63+
64+
Which creates a "my-test-playbook" directory with the skeleton playbook file
65+
"playbook". The playbook used to create this skeleton is in
66+
".uplaybooks/new-uplaybook/playbook"
67+
5868
## State
5969

60-
Currently (Oct 2023) this is experimental: the core functionality is implemented
61-
and it is usable with a limited number of tasks(). My next steps are to improve the
62-
documentation, and start using it in real world applications to allow me to prove out
63-
or adjust the design.
70+
This is Beta software: The core is done but as it gets real world use things
71+
may change in incompatible ways before final release.
72+
73+
Currently (Nov 2023) I'm working on:
74+
75+
- Documentation.
76+
- Test driving uPlaybook to find rough edges.
77+
- Adding more Tasks.
6478

6579
If you look at it, your feedback would be appreciated.
6680

0 commit comments

Comments
 (0)