more official readme with steps

README.md

@@ -1,19 +1,113 @@
-# PSWorkerPrototype
-Prototype for Azure Functions PowerShell Language Worker
+# Azure Functions PowerShell Language Worker
 
-## Steps
+This repository will host the PowerShell language worker implementation for Azure Functions.
+We'll also be using it to track work items related to PowerShell support.
+Please feel free to leave comments about any of the features and design patterns.
 
-1. Modify `DefaultExecutablePath` in `worker.config.json` (to something like this `"C:\\Program Files\\dotnet\\dotnet.exe"`)
-2. `cd path/to/PSWorkerPrototype`
-3. `dotnet publish`
-4. Run:
+> 🚧 The project is currently **work in progress**.
+Please do not use in production as we expect developments over time.
+To receive important updates, including breaking changes announcements,
+watch the Azure App Service announcements repository. 🚧
 
-```powershell
-# Windows if you installed the Azure Functions Core Tools via npm
-Remove-Item -Recurse -Force ~\AppData\Roaming\npm\node_modules\azure-functions-core-tools\bin\workers\powershell
-Copy-Item src\bin\Debug\netcoreapp2.1\publish ~\AppData\Roaming\npm\node_modules\azure-functions-core-tools\bin\workers\powershell -Recurse -Force
+## Overview
 
-# macOS if you installed the Azure Functions Core Tools via brew
-Remove-Item -Recurse -Force /usr/local/Cellar/azure-functions-core-tools/2.0.1-beta.33/workers/powershell
-Copy-Item src/bin/Debug/netcoreapp2.1/publish /usr/local/Cellar/azure-functions-core-tools/2.0.1-beta.33/workers/powershell -Recurse -Force
-```
+PowerShell support for Functions is based on [PowerShell Core 6.1](https://github.com/powershell/powershell),
+[Functions on Linux](https://blogs.msdn.microsoft.com/appserviceteam/2017/11/15/functions-on-linux-preview/),
+and the [Azure Functions runtime V2](https://docs.microsoft.com/en-us/azure/azure-functions/functions-versions).
+
+What's available?
+
+* Triggers / Bindings : HTTP/Webhook
+
+What's coming?
+
+* More triggers and bindings
+* Tooling integration
+* A bunch of other good things
+
+## Contributing
+
+> This project is **not currently taking pull requests**
+because it's still in the early development and is changing rapidly.
+
+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.
+
+## Building from source
+
+### Prereqs
+
+* [.NET 2.1 SDK](https://www.microsoft.com/net/download/visual-studio-sdks)
+
+### Build
+
+* Clone this repository
+* `cd azure-functions-powershell-worker`
+* `dotnet publish`
+* Make note of the location of the publish directory:
+`src/bin/Dubug/netcoreapp2.1/publish`
+
+### Run & Debug
+
+The PowerShell worker alone is not enough to establish the functions app, we also need the support from
+[Azure Functions Host](https://github.com/Azure/azure-functions-host).
+You may either use a published host CLI or use the in-development host.
+But both of the methods require you to attach to the .NET process if you want a step-by-step debugging experience.
+
+#### Published Host
+
+First, follow the [instructions to install the Azure Functions Core Tools](https://github.com/Azure/azure-functions-core-tools#installing).
+Then locate the `azure-functions-core-tools\bin\workers\` folder.
+Here are a few hints on where it could be located:
+
+On Windows if you installed via `npm`
+```
+~\AppData\Roaming\npm\node_modules\azure-functions-core-tools\bin\workers\
+```
+On macOS if you installed via `brew`
+```
+/usr/local/Cellar/azure-functions-core-tools/<version>/workers/
+```
+
+Copy the result of the `publish` directory into a `powershell` folder under `workers` so it looks something like:
+```
+/usr/local/Cellar/azure-functions-core-tools/<version>/workers/powershell/<contents of publish directory>
+```
+
+Then `cd` into a Function App with PowerShell as the worker runtime 
+(NOTE: There's an example PowerShell Function App in the `examples` folder).
+
+Lastly, run:
+
+```
+func start
+```
+
+#### Latest Host
+
+A developer may also use the latest host code by cloning the git repository [Azure Functions Host](https://github.com/Azure/azure-functions-host).
+Now you need to navigate to the root folder of the host project and build it through:
+
+```sh
+dotnet restore WebJobs.Script.sln
+dotnet build WebJobs.Script.sln
+```
+
+After the build succeeded,
+set the environment variable `"AzureWebJobsScriptRoot"`
+to the root folder path (the folder which contains the `host.json`)
+of your test functions app.
+
+Then copy the `publish` directory to
+`"<Azure Functions Host Root>/src/WebJobs.Script.WebHost/bin/Debug/netcoreapp2.1/workers/powershell"`.
+
+Then you can start the host but running:
+```sh
+dotnet ./src/WebJobs.Script.WebHost/bin/Debug/netcoreapp2.1/Microsoft.Azure.WebJobs.Script.WebHost.dll
+```
+
+> Note: Remember to remove `"AzureWebJobsScriptRoot"`
+environment variable after you have finished debugging,
+because it will also influence the `func` CLI tool.