Initial

README.md

@@ -1,5 +1,21 @@
+# Node.js Sample Project for Visual Studio Remote - Containers
 
-# Contributing
+This is a sample project to go along with the "try" quick start for the VS Code Remote - Containers extension.
+
+Using the sample:
+
+1. **[Windows]** Disable automatic line ending conversion for Git on the *Windows side* (given Linux and Windows use different line endings). Run: `git config --global core.autocrlf false`
+2. Follow the steps at [https://aka.ms/vsocde-remote/containers/getting-started](https://aka.ms/vsocde-remote/containers/getting-started).
+3. Run `yarn install`
+4. Launch the application, edit, and try things out!
+
+Other samples and dev container definitions:
+- [Node.js](https://github.com/Microsoft/vscode-dev-containers/tree/master/containers/javascript-node-lts)
+- [Node.js & Mongo DB](https://github.com/Microsoft/vscode-dev-containers/tree/master/containers/javascript-node-lts-mongo)
+- [Node.js & TypeScript](https://github.com/Microsoft/vscode-dev-containers/tree/master/containers/typescript-node-lts)
+- [Azure Functions & Node.js](https://github.com/Microsoft/vscode-dev-containers/tree/master/containers/azure-functions-node-lts)
+
+## Contributing
 
 This project welcomes contributions and suggestions.  Most contributions require you to agree to a
 Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
@@ -12,3 +28,8 @@ provided by the bot. You will only need to do this once across all repos using o
 This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
 For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
 contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+
+## License
+
+Copyright © Microsoft Corporation All rights reserved.<br />
+Licensed under the MIT License. See LICENSE in the project root for license information.