docs: README Update #201
docs: README Update #201
Conversation
| @@ -1,61 +1,46 @@ | |||
| # Azure Functions Serverless Plugin | |||
| # Azure Functions Serverless Plugin | |||
There was a problem hiding this comment.
We'll need to add more in addition to the quickstart. But this is good for now.
|
Did we ever resolve Hema's comments? |
|
|
||
| ### Pre-requisites | ||
|
|
||
| 1. Node.js v6.5.0+ *(this is the runtime version supported by Azure Functions)* |
There was a problem hiding this comment.
should follow markdown list syntax and use
1. one
1. two
1. three
There was a problem hiding this comment.
The markdown guide lists the actual numbered version as the first style, but they both render to the same thing. Also, the VS Code extension auto-generates the next number with a new line.
|
|
||
| The getting started walkthrough illustrates the interactive login experience, which is recommended when getting started. However, for more robust use, a [service principal](https://docs.microsoft.com/en-us/azure/active-directory/develop/app-objects-and-service-principals) is recommended for authentication. | ||
|
|
||
| ##### Creating a Service Principal |
There was a problem hiding this comment.
can you add reference to use the script I wrote?
There was a problem hiding this comment.
We should talk about where that should live. I don't know if it's in the quickstart, just because we expose that script in the scripts section of package.json, and it would be kinda awkward for people that were consuming the plugin to drill into node_modules to go run the script. If that script were available in the project template, then I think it would make sense to be here. I think that would go in other more detailed dev docs, just because we'd have to have other instructions like installing jq. Open to chat about where to put that in the future, but I'll probably leave it out for now
Update readme for current state of project Resolves [AB#483]
Update README to reflect current state of plugin.
[AB#483]