README.md in learn_create-0.0.9 vs README.md in learn_create-0.0.10
- old
+ new
@@ -1,20 +1,30 @@
# Learn Create
This gem is designed to aid in the creation of learn lessons.
-## Installation
+## Installation and Setup
Before using `learn_create`, you must install `hub`, GitHub's extended CLI API.
```sh
$ brew install hub
```
-Once `hub` is installed, you when it is first run, it will require your GitHub
-credentials. Install the `learn_create` gem:
+Once `hub` is installed, you'll need to get it configured before running
+`learn_create`. The best way to do this is to use `hub` once to create a
+repository on learn-co-curriculum. In the shell:
+- Create a new, empty folder and navigate into it
+- Run `hub create learn-co-curriculum/<whatever name you've chosen>`
+ - You should be prompted to sign into GitHub
+- If everything works as expected you should now have an empty
+ learn-co-curriculum repo
+- Delete the repo. Everything should be set up now.
+
+Install the `learn_create` gem:
+
```sh
$ gem install learn_create
```
## Usage
@@ -25,6 +35,13 @@
```sh
learn_create
```
Follow the command line prompts for setting up and naming your repository. The
-repo will be created locally and pushed to GitHub.
+repo will be created locally and pushed to GitHub. When finished, you can `cd`
+into the local folder or open it on github to start working.
+
+## Resources
+
+- [Hub]
+
+[hub]: https://hub.github.com/hub.1.html