Updating documentation

GeorgeSapkin · GeorgeSapkin · commit bd9ef2edeab7 · 2018-02-24T23:47:09.000+01:00
diff --git a/week1/MAKEME.md b/week1/MAKEME.md
@@ -2,7 +2,7 @@
 
 ## Assignment
 
-Create an http server that can add and subtract from a number, which we will
+Create an HTTP server that can add and subtract from a number, which we will
 call `state`. Use project in `week1` directory as starting material.
 Pay extra attention to line 21, which contains some hints for this week
 `console.log('New http request received', request.url);`
@@ -67,9 +67,9 @@ Read: http://callbackhell.com/
 Video: https://www.youtube.com/watch?v=e1Ln1FrLvh8
 Read: http://openmymind.net/2012/2/3/Node-Require-and-Exports/
 
-### `http`, listen
+### `http`, `listen`
 - Video basic: https://www.youtube.com/watch?v=pYOltVz7kL0
-- Video routing: https://www.youtube.com/watch?v=_D2w0voFlEk (please focus on request.url, not request.method)
+- Video routing: https://www.youtube.com/watch?v=_D2w0voFlEk (please focus on `request.url`, not `request.method`)
 - Read: [Node.js documentation about `http`](https://nodejs.org/en/docs/guides/anatomy-of-an-http-transaction/)
 - Read Advanced:
 
diff --git a/week1/README.md b/week1/README.md
@@ -4,6 +4,19 @@
 will dominate the web development world. Instead, it’s a platform that fills a
 particular need."
 
+## Agenda
+
+1. Recap last week
+2. Previous homework
+3. Questions & Answers (Q&A)
+4. What is Node.js?
+5. Setting up a Node.js project using `npm init`
+6. Importing modules using `require`
+5. Building an HTTP server using built-in `http` module
+    1. HTTP methods
+    2. HTTP status codes
+8. Homework
+
 ### What is Node.js?
 
 [What is Node.js? What can you do with it? Why should you use it?](https://medium.com/@paynoattn/what-is-nodejs-what-can-you-do-with-it-why-should-you-use-it-8c8d6df32d6d#.qvbp8g4dq)
@@ -14,14 +27,10 @@ _estimated time: 10 minutes_
 Tutorials: [NPM tutorials. Follow chapters 1 - 10](https://docs.npmjs.com/getting-started/installing-node)
 _estimated time: 4-6 hours_
 
-### Asynchronous callbacks
-
-Although most of this was already covered by the JavaScript class, let's refresh
-our memories on Callbacks.
+### Promises' refresher
 
-Read: [Understanding Asynchronous JavaScript Callbacks Through Household Chores
-](https://medium.freecodecamp.com/understanding-asynchronous-javascript-callbacks-through-household-chores-e3de9a1dbd04#.8ilr4a7aj)
-_estimated time: ~1 hour_
+Jim's [summary of promises](https://github.com/remarcmij/JavaScript/blob/master/fundamentals/promises.md)
+from JavaScript module.
 
 ### Control flow and events
 
diff --git a/week2/MAKEME.md b/week2/MAKEME.md
@@ -1,23 +1,72 @@
-> Please help us improve and share your feedback! If you find better tutorials or links, please share them by opening a Pull Request.
-
 # HackYourFuture Node.js - Homework week 2
 
 ## Assignment for this week
+
 These are the specs for this week's assignment:
-- The user can run a NodeJs to-do app
-- The user can be able to run the file using node index.js
-- There should be a "help" section that lists all the commands for how to use the app
+
+- The user can run a Node.js to-do app
+- The user must be able to run the file using `node index.js`
+- There should be a "help" section that lists all the commands for how to use
+  the app
 
 The following commands should be present:
-- No command: show help section (`node index.js`)
-- help: show help section (`node index.js help`)
-- list: show current todo's, or show an appropriate text if there are no todos (`node index.js list`)
-- add: add a todo item. all the words behind "add" are entered as 1 todo item to the list (`node index.js add "Buy groceries"`)
-- remove: remove a todo item by its 1-base index. (`node index.js remove 2`)
-- reset: remove all todo items from the list (`node index.js reset`)
 
-- *BONUS:* update: update a todo item with new text (`node index.js update 3 "Wash teeth"`)
+### No command or `help`
+
+Shows help section
+
+```
+node index.js
+```
+
+or
+
+```
+node index.js help
+```
+
+### `list`
+
+Shows current to-dos, or shows an appropriate text if there are no to-dos
+
+```
+node index.js list
+```
+
+### `add`
+
+Adds a to-do item. All the words behind `add` are entered as 1 to-do item to the
+list.
+
+```
+node index.js add "Buy groceries"
+```
+
+### `remove`
+
+Removes a to-do item by its 1-base index, e.g. to remove second item, execute:
+
+```
+node index.js remove 2
+```
+
+### `reset`
+
+Removes all to-do items from the list:
+
+```
+node index.js reset
+```
+
+### *BONUS:* `update`
+
+Updates a to-do item with new text:
+
+```
+node index.js update 3 "Wash teeth"
+```
+
+### Things to consider
 
-### Consider this:
 - What representation you use in your file (CSV, TSV, JSON, ...)
 - Handle edge cases, i.e. control what happens if user enters unexpected input
diff --git a/week2/README.md b/week2/README.md
@@ -1,61 +1,44 @@
-> Please help us improve and share your feedback! If you find better tutorials or links, please share them by opening a Pull Request.
-
 # HackYourFuture Node.js - Reading material week 2
 
 ## Last weeks Summary
-Last week we looked at building an HTTP interface. The interface allowed us to get a state, and manipulate the state (add, subtract, reset).
 
-## Today's meal
+Last week we looked at building an HTTP interface. The interface allowed us to
+get a state, and manipulate the state (add, subtract, reset).
+
+## Agenda
+
 1. Recap last week
-2. Homework
+2. Previous homework
 3. Questions & Answers (Q&A)
-4. Other topics
-4. Persisting data beyond the lifetime of the app.
-5. Building a Command Line Interface / Working with arguments
-6. Using Node.JS's FileSystem (FS)
+4. Persisting data beyond the lifetime of the app
+5. Building a command line interface (CLI)
+6. Accessing file system with Node.js `fs` module
 7. CRUD operations
-8. This week's assignment
+8. Homework
 
 ## Reading material
 
-### Something about ES6 I want you guys to know
-You may hear us talking about this "ES6" all the time. ES6 basically means: the latest version of JavaScript. It has a lot of really nice new features that makes life as developer easier. For you guys, you should remember the following:
-> During the NodeJS course, we will teach you some ES6 features, like Fat Arrow. It's *extremely* important to know whether a function comes from ES6 or from an older version of JavaScript. Why? [Because browsers don't support every new feature just yet](http://kangax.github.io/compat-table/es6/). With Node, on the other hand, you can always control which version of Javascript is running, because it's running on your computer, not in the browser. Node Version 6.x that you are running supports most ES6.
-So in summary: if you're working on the frontend, you probably don't want to use es6 just yet. In backend, type node --version to see which version you are running, and make sure everyone on the team has the same version by adding "engine" to `package.json` like so:
-
-```js
-"dependencies": {
-  ...
-},
-"devDependencies": {
-  ...
-},
-"engines": {
-  "node": ">=6.5.0" // this means you need 6.5 or higher
-},
-```
-
-### 1. ES6: Fat Arrow functions
-This is one example of how ES6 can help us write cleaner code. I'm adding this as first reading material because it's used a lot on the NodeJS documentation website, so it's a good idea to understand what this means. Bonus points if you write your callbacks this way.
-[Blogpost Sitepoint]([https://www.sitepoint.com/es6-arrow-functions-new-fat-concise-syntax-javascript/)
-[Video]([https://www.youtube.com/watch?v=J85lRtO_yjY)
-
-### 2. NodeJS Process:
-Don't have to remember everything in this video, just a nice outline
+### Node.js process:
+
+You Don't have to remember everything in this video, just a nice outline
 [Egghead video tutorial](https://egghead.io/lessons/node-js-the-node-js-process-object)
 Only read the part about "process.argv"
 [Node.JS docs - process.argv](https://nodejs.org/docs/latest/api/process.html#process_process_argv)
 
-### 3. NodeJS FS
-Only read the part about readFile, appendFile (you will need this in your assignment)
-[Node.JS docs - fs.readFile](https://nodejs.org/api/fs.html#fs_fs_readfile_file_options_callback)
-[Node.JS docs - fs.appendFile](https://nodejs.org/api/fs.html#fs_fs_appendfile_file_data_options_callback)
+### Node.js file system module `fs`
+
+[Main documentation](https://nodejs.org/docs/latest-v8.x/api/fs.html)
+
+[fs.readFile()](https://nodejs.org/docs/latest-v8.x/api/fs.html#fs_fs_readfile_path_options_callback)
+[fs.appendFile()](https://nodejs.org/docs/latest-v8.x/api/fs.html#fs_fs_appendfile_file_data_options_callback)
+
+### Node Fundamentals
 
-### 4. Node Fundamentals
 Read parts:
 - 3.1, 3.2
 - 4.1, 4.3
 [Airpair tutorial](https://www.airpair.com/javascript/node-js-tutorial#3-node-fundamentals)
 
 ## As you finish that up, don’t forget to watch next week’s video playlist to prepare for Express.
->You’ll find it here: [Lynda :information_desk_person:](https://www.lynda.com/SharedPlaylist/e8a2fec772bb462da38429629a34f3b7)
+
+You’ll find it here: [Lynda :information_desk_person:](https://www.lynda.com/SharedPlaylist/e8a2fec772bb462da38429629a34f3b7)
