Skip to content

Commit 7c83a17

Browse files
author
Clark Perkins
committed
Cleaned up README
1 parent 38b4137 commit 7c83a17

File tree

1 file changed

+9
-13
lines changed

1 file changed

+9
-13
lines changed

README.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,32 +23,31 @@ but in short you can install it on most systems like:
2323

2424
Once you've got it, installing this tool goes something like:
2525

26-
mkvirtualenv stackdio-tooling
26+
mkvirtualenv stackdio-client
2727

2828
# assuming you are in whatever dir you cloned this repo to:
29-
pip install --process-dependency-links .
29+
pip install .
3030

31-
** The --process-dependency-links flag is only needed in pip 1.5.6 **
3231
You'll see a few things scrolling by, but should be set after this. To use
3332
this later, you'll need to re-activate the virtualenv like:
3433

35-
workon stackdio-tooling
34+
workon stackdio-client
3635

3736
Whenever it's activated, `stackdio-cli` should be on your path.
3837

3938
## First Use
4039
The first time that you fire up `stackdio-cli`, you'll need to run the
41-
`initial-setup` command. This will prompt you for your LDAP username and
40+
`initial_setup` command. This will prompt you for your LDAP username and
4241
password, and store them securely in your OS keychain for later use. It will
4342
import some standard formula, and create a few commonly used blueprints.
4443

4544
$ stackdio-cli
46-
None @ https://stackd.corp.digitalreasoning.com/api/
45+
None @ None
4746
> initial_setup
4847
# YOU WILL BE WALKED THROUGH A SIMPLE SET OF QUESTIONS
4948

5049
## Stack Operations
51-
All of the following assume that you have run `initial-setup` successfully. To
50+
All of the following assume that you have run `initial_setup` successfully. To
5251
launch the cli, simply type:
5352

5453
$ stackdio-cli
@@ -64,7 +63,7 @@ included with this you do:
6463
> stacks launch cdh450-ipa-3 MYSTACKNAME
6564

6665
**NOTE:** To avoid DNS namespace collisions, the stack name needs to be unique.
67-
An easy way to ensure this is to include your name in the stack name.
66+
An easy way to ensure this is to include your name in the stack name.
6867

6968
### Deleting Stacks
7069
When you are done with a stack you can delete it. This is destructive and
@@ -98,10 +97,7 @@ There are various logs available that you can access with the `stacks logs`
9897
command.
9998

10099
## What's Next?
101-
For anything not covered by this tool, you'll need to use the [web UI] or
102-
[API] directly. See someone on the [pi team] with specific questions.
100+
For anything not covered by this tool, you'll need to use the stackdio-server web UI or
101+
API directly. For more information on that, check out http://docs.stackd.io.
103102

104103
[virtualenvwrapper]: https://pypi.python.org/pypi/virtualenvwrapper
105-
[web UI]: https://stackd.corp.digitalreasoning.com
106-
[API]: https://stackd.corp.digitalreasoning.com/api
107-
[pi team]: mailto:pi@digitalreasoning.com?subject=stackd.io%20questions

0 commit comments

Comments
 (0)