add deployment steps and Contrib details

Author: fboucher

CONTRIBUTING.md

@@ -0,0 +1,74 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.

README.md

@@ -1,3 +1,84 @@
-## Note Bookmark
+# Note Bookmark
 
 [![.github/workflows/azure-dev.yml](https://github.com/FBoucher/NoteBookmark/actions/workflows/azure-dev.yml/badge.svg)](https://github.com/FBoucher/NoteBookmark/actions/workflows/azure-dev.yml)
+
+I use this project mostly everyday. I build it to help me collecting my thoughts about articles, and blob posts I read during the week and then aggregate them in a #ReadingNotes blog post. You can find those post on my blog [here](https://frankysnotes.com).
+
+NoteBookmark is composed of three main sections:
+
+- **Post**: where you can manage a posts "to read", and add notes to them.
+- **Generate Summary**: where you can generate a summary of the posts you read.
+- **Summaries**: where you can see all the summaries you generated.
+
+![Slide show of all NoteBookmark Screens](gh/images/NoteBookmark-Tour_hd.gif)
+
+## How to deploy Your own NoteBookmark
+
+### Get the code on your machine
+
+- Fork this repository to your account.
+- Clone the repository to your local machine.
+
+### Create the Azure Storage
+
+Curretly the project assumed you already have an Azure Storage account, therefor its creation is exclude of the deployment. Let's create one now and retreive it's ConnectionString using a Azure CLI comnand (you can also use the Azure Portal is you prefer).
+
+Here in Bash: 
+
+```bash
+resourceGroupName="notebookmark-dev"
+location="eastus"
+storageAccountName="notedata"
+
+az group create --name $resourceGroupName --location $location
+
+az storage account create --name $storageAccountName --resource-group $resourceGroupName --location $location --sku Standard_LRS
+
+az storage account show-connection-string --name $storageAccountName --resource-group $resourceGroupName
+```
+
+and PowerShell:
+
+```powershell
+$resourceGroupName = "notebookmark-dev"
+$location = "eastus"
+$storageAccountName = "notedata"
+
+az group create --name $resourceGroupName --location $location
+
+az storage account create --name $storageAccountName --resource-group $resourceGroupName --location $location --sku Standard_LRS
+
+az storage account show-connection-string --name $storageAccountName --resource-group $resourceGroupName
+```
+
+Save this connection string, you will need it later.
+
+### Deploy the soluiton 
+
+Using Azure Developer CLI let's initialize your environment. In a terminal, at the root of the project, run the following command. When ask give it a name (ex: NoteBookmark-dev).
+
+```bash
+azd init
+```
+
+Now let's deploy the solution. Run the following command in the terminal. You will have to select your Azure subscription where you want to deploy the solution, a location (use the same as for the storage creation earlier), and paste the connection string you saved earlier when asked for the 'data_storage_connstr'.
+
+```bash
+azd up
+```
+
+It should take around five minutes to deploy the solution. Once it's done, you will see the URL for **Deploying service blazor-app**.
+
+### Secure the App
+
+The app is now deployed, but it's not secure. Navigate to the Azure Portal, and find the Resource Group you just deployed (ex: rg-notebookmark-dev). In this resource group, open the Container App **Container App**. From the left menu, select **Authentication** and click the **Add identity provider**.
+
+You can choose between multiple providers, I like to use Microsoft since it's deploy in Azure and I'm already logged in. If Microsoft is choose, select the recomended **Client secret expiration** (ex: 180 days). You can keep all the other default settings. Click **Add**.
+
+Next time you will navigate to the app, you will be prompt a to login with your Microsoft account. The first time you will have a **Permissions requested** screen, click **Accept**.
+
+Voila! Your app is now secure.
+
+## Contributing
+
+Your contributions are welcome! Take a look at [CONTRIBUTING](/CONTRIBUTING.md) for details.