-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
based on README.md by https://github.com/stevekane/promise-it-wont-hurt
- Loading branch information
Showing
1 changed file
with
57 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,67 @@ | ||
# async-you | ||
# async-you | ||
|
||
**I see you** | ||
|
||
An introduction and guide to using https://github.com/caolan/async package. | ||
|
||
[](https://nodei.co/npm/async-you/) [](https://nodei.co/npm/async-you/) | ||
|
||
## Introduction | ||
|
||
Learn to use the popular package [async](https://github.com/caolan/async) via this interactive workshop. | ||
|
||
Hopefully by the end this workshop you will understand the main functions that _async_ provides. | ||
|
||
## Installation | ||
|
||
1. Install [Node.js](http://nodejs.org/) | ||
2. Run `sudo npm install async-you -g` | ||
3. Run `async_you` | ||
4. **.. profit!** | ||
|
||
<b><code>async-you</code></b> will run through a series of Node.js workshops to teach you | ||
how to use the awesome [async](https://github.com/caolan/async) package. | ||
## Usage | ||
|
||
#### 1. Selecting a problem to work on | ||
|
||
Once the workshop is installed, run `async_you` to print a menu | ||
where you can select a problem to work on. | ||
|
||
``` | ||
$ async_you | ||
``` | ||
|
||
Problems are listed in rough order of difficulty. You are advised to complete them in order, as later problems | ||
will build on skills developed by solving previous problems. | ||
|
||
#### 2. Writing your solution | ||
|
||
Once you have selected a problem, the workshop will remember which problem you are working on. | ||
Using your preferred editor, simply create a file to write your solution in. | ||
|
||
#### 3. Testing your solution | ||
|
||
Use the workshop's `run` command to point the workshop at your solution file. Your solution will loaded | ||
and passed the problem input. This usually won't perform any validation, it will only show the program output. | ||
|
||
``` | ||
$ async_you run mysolution.js | ||
``` | ||
|
||
#### 4. Verifying your solution | ||
|
||
Your solution will be verified against the output of the 'official' solution. | ||
If all of the output matches, then you have successfully solved the problem! | ||
|
||
``` | ||
$ async_you verify mysolution.js | ||
``` | ||
|
||
## Stuck? | ||
|
||
Feedback and critisism is welcome, please log your troubles in [issues](https://github.com/bulkan/async-you). | ||
|
||
## Resources | ||
|
||
## Thanks rvagg | ||
|
||
This tutorial was built using rvagg's [workshopper](https://github.com/rvagg/workshopper) framework. | ||
|
||
## Licence | ||
MIT |