diff --git a/README.md b/README.md index 5b98b0c..f26a3c1 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,17 @@ # Docker Tools Documentation + A list of tools being developed at Microsoft for working with Docker Containers -##Docker Tools for Visual Studio## -![Docker Tools for Visual Studio](./media/DockerToolsForVSLogo.png) +## Docker Tools for Visual Studio +![Docker Tools for Visual Studio](./media/DockerToolsForVSLogo.png) [DockerToolsForVisualStudio ](http://aka.ms/DockerToolsForVS) The Visual Studio 2015 Tools for Docker Preview enables developers to build and debug their applications in a locally hosted Docker container and publish their application to an Azure Docker Host. +## yo docker -##yo docker## ![yo docker](./media/yodockerLogo.png) Scaffolding of Dockerfiles and scripts to build and run your Docker containers @@ -28,8 +29,7 @@ To assist developers getting started, and those developers already using docker [A 5 minute demo showing yo docker with NodeJS apps and VSCode](https://youtu.be/p1F-398z1_4) - -###Installing yo docker on Mac### +### Installing yo docker on Mac 1. Install [NodeJs](http://nodejs.org) 2. Install Yo by running the following command from the Terminal: @@ -42,21 +42,28 @@ To assist developers getting started, and those developers already using docker `yo docker` -###Installing yo docker on Windows### +### Installing yo docker on Windows + *Coming soon* -While you can install the same yo docker tools above for the mac, the scripts generated are bash scripts. We are working on generating .cmd scripts as a Windows Developer would expect. +> While you can install the same yo docker tools above for the mac, the scripts generated are bash scripts. We are working on generating .cmd scripts as a Windows Developer would expect. + +### Contributing to yo docker -###Contributing to yo docker### We are planning to make yo docker open sourced, accepting pull requests. *stay tuned* -##Getting Started Samples## +## Getting Started Samples + For those looking for some simple Hello World samples for GOLang, NodeJS and soon ASP.NET, you can download these: + - [Container Ready Hello World Samples](https://github.com/Microsoft/dockertools-sampleprojects) These samples do NOT yet have the Docker assets added. The idea is you would use `yo docker` to enhance these. -###NodeJS Hello World Sample### + +### NodeJS Hello World Sample + To use the NodeJS sample + - In the root directory execute: `npm install` to restore the node packages - to get nodemon support, execute: `sudo npm install -g nodemon` - to start the app with nodemon, execute: `nodemon`