diff --git a/README.md b/README.md index 5a28470..4c471b0 100644 --- a/README.md +++ b/README.md @@ -1 +1,5 @@ -# cheatsheets \ No newline at end of file +# Cheatsheets + +A set of cheatsheets and glossary terms that will be useful for completing the Node Girls workshops. + +* [Node Cheatsheet](https://github.com/node-girls/cheatsheets/master/node-cheatsheet.md) diff --git a/node-cheatsheet.md b/node-cheatsheet.md new file mode 100644 index 0000000..a4deb24 --- /dev/null +++ b/node-cheatsheet.md @@ -0,0 +1,16 @@ +# Node Cheatsheet + +A glossary of terms for Node.js. + + +| Term | Meaning | +|----------------|----------------------------------| +| `Node.js` | JavaScript for servers. | +| `web server` | Program that processes requests for the internet via HTTP. | +| `HTTP` | Short for HyperText Transfer Protocol. The set of standards for transferring files over the internet. | +| `npm` | Package manager for Node.js. Allows you to install and publish open source Node projects. | +| `npm package` | Open source Node project, published on npm. | +| `npm init` | Command run in the terminal to initialise your Node project and create a package.json file. | +| `npm install ` | Command run in the terminal to install an npm package. | +| `package.json` | File holding various metadata about a Node project, such as project name, description or license information, installed packages (or dependencies). Usually located in the root directory. Package.json cheatsheet [here](http://browsenpm.org/package-json). | +| `dependencies` | Packages installed from npm that are necessary to run the project successfully. Listed in the package.json. |