Create release (#8)

* Update readme
* create release workflow

.github/workflows/release.yml

@@ -0,0 +1,65 @@
+name: Release
+
+on:
+  push:
+    tags:
+    - 'v*'
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        fetch-depth: 0
+
+    - name: Use Node.js
+      uses: actions/setup-node@v1
+      with:
+        node-version: '14.X'
+
+    - name: Install dependencies
+      run: yarn --frozen-lockfile
+
+    - name: Build
+      run: yarn build
+
+    # Docker Image
+
+    - name: get-npm-version
+      id: package-version
+      uses: martinbeentjes/[email protected]
+
+    - name: Build the Docker image
+      run: docker build . --tag dependencies-graph-graphql:${{ steps.package-version.outputs.current-version }}
+
+    - name: Docker login
+      run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login docker.pkg.github.com -u ${{ github.actor }} --password-stdin
+
+    - name: Docker push
+      run: | 
+        docker tag dependencies-graph-graphql:${{ steps.package-version.outputs.current-version }} docker.pkg.github.com/xclemence/dependencies-graph-graphql/dependencies-graph-graphql:${{ steps.package-version.outputs.current-version }}
+        docker push docker.pkg.github.com/xclemence/dependencies-graph-graphql/dependencies-graph-graphql:${{ steps.package-version.outputs.current-version }}
+    
+    # Release Creation
+    - uses: olegtarasov/get-tag@v2
+      id: tagName
+
+    - name: Read Release Notes
+      id: release_notes
+      uses: juliangruber/read-file-action@v1
+      with:
+        path: ./doc/releases/${{ steps.tagName.outputs.tag }}.md
+
+    - name: Create Release
+      id: create_release
+      uses: actions/create-release@v1
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      with:
+        tag_name: ${{ github.ref }}
+        release_name: Release ${{ github.ref }}
+        body: ${{ steps.release_notes.outputs.content }}
+        draft: false
+        prerelease: false

.typo-ci.yml

@@ -0,0 +1,22 @@
+dictionaries:
+  - en
+  - en_GB
+
+# Any files/folders we should ignore?
+excluded_files:
+  - ".typo-ci.yml"
+  - ".devcontainer/*"
+  - ".gitignore"
+  - ".github/*"
+  - "docker/*"
+  - "yarn.lock"
+
+
+# Any typos we should ignore?
+excluded_words:
+  - devcontainer
+  - Softwares
+  - graphql
+
+# Would you like filenames to also be spellchecked?
+spellcheck_filenames: true

README.md

@@ -1 +1,61 @@
-# dependencies-graph-graphql
+# Dependencies Graph GraphQL
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](/LICENSE)
+[![Build][github-actions-badge]][github-actions]
+[![Quality Gate Status][sonar-project-badge]][sonar-project]
+
+Dependencies Graph GraphQL provides GraphQL entry point retrieve assemblies and these dependencies. behind service, a [Neo4j][neo4j-url] database ensures graph storage.
+
+## Features
+
+* Get assemblies information
+* Get software information
+
+# How to use
+
+## Build sources
+- `yarn dev` for development. Navigate to `http://localhost:4001/graphql`. The app will automatically reload if you change any of the source files.
+- `ng build` to build the project.
+
+> *This project is configured to work with the [Remote Development][remote-development-plugin-url] plugin.*
+
+With your server still running, visit `http://localhost:4001` in your browser to open GraphQL Playground (provide by **Apollo Server**)
+
+<img src="doc/images/graphql-playground.png"/>
+
+## Docker image
+
+A Docker image with this software is available from the [packages][github-package] page.
+
+This image is base on **Linux**. 
+
+You can configure container by setting environment variables.
+
+| Environment variable     |          Comment           |   default value     |
+|------------------------- | :--------------------------|-------------------- |
+| NEO4J_HOST               | Noe4j database uri         | bolt://localhost    |
+
+Port exposed by Container:
+
+|        Name        |       Description                |
+| -------------------|--------------------------------- |
+| 4001               | HTTP port for GraphQL services   |
+
+You can start a Dependencies Graph Viewer container like this:
+
+```
+docker run \
+    --publish=4001:4001 \
+    dependencies-graph-graphql:tag
+```
+
+[github-actions]:                   https://github.com/xclemence/Dependencies-graph-graphql/actions
+[github-actions-badge]:             https://github.com/xclemence/dependencies-graph-graphql/workflows/Node.js%20CI/badge.svg?branch=master
+
+[sonar-project]:                    https://sonarcloud.io/dashboard?id=xclemence_dependencies-graph-graphql
+[sonar-project-badge]:              https://sonarcloud.io/api/project_badges/measure?project=xclemence_dependencies-graph-graphql&metric=alert_status
+
+[neo4j-url]:                        https://neo4j.com/
+[remote-development-plugin-url]:    https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.vscode-remote-extensionpack 
+
+[github-package]:                   https://github.com/xclemence/dependencies-graph-services/packages

doc/releases/v1.0.0.md

@@ -0,0 +1,9 @@
+### Features
+- Graphql entry point (filter / order by / count) for :
+    - Assembly
+    - Software
+
+### Package
+- Docker container
+
+To download assets go to [the packages page](https://github.com/xclemence/dependencies-graph-viewer/packages)