Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ddecrulle committed Sep 22, 2022
1 parent ff41e1a commit 533648d
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
<h1 align="center">Welcome to Knowledge 👋</h1>

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![ci](https://github.com/ddecrulle/Knowledge/actions/workflows/ci.yaml/badge.svg)](https://github.com/ddecrulle/Knowledge/actions/workflows/ci.yaml)

<p align="center">
<a href="https://socialify.git.ci/ddecrulle/knowledge?description=1&descriptionEditable=The%20application%20that%20presents%20service%20offer%20of%20the%20INSEE%20survey%20information%20system%20&forks=1&issues=1&language=1&name=1&owner=1&pulls=1&theme=Light">
<img alt="socialify image" src="https://socialify.git.ci/ddecrulle/knowledge/image?description=1&descriptionEditable=The%20application%20that%20presents%20service%20offer%20of%20the%20INSEE%20survey%20information%20system%20&forks=1&issues=1&language=1&name=1&owner=1&pulls=1&theme=Light" alt="Knowledge" width="640" height="320" />
</a>
</p>

<p align="center">
<a href="">
<img src="https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT"/>
<img src="https://github.com/ddecrulle/Knowledge/actions/workflows/ci.yaml/badge.svg)](https://github.com/ddecrulle/Knowledge/actions/workflows/ci.yaml">
</a>

</p>

Knowledge is built with React. It was initialized with a classic Create React App and is deisgned thanks to Material UI

## Getting started
Expand Down Expand Up @@ -43,4 +48,3 @@ In development mode, you can create a file `.env.local` and add values like in t
This project follows [Conventional Commits 1.0.0](https://www.conventionalcommits.org/en/v1.0.0/). To enforce that convention we have a [commitlint](https://github.com/conventional-changelog/commitlint) which lint commits before they are created thanks to [husky](https://typicode.github.io/husky/#/)

The commitlint configuration can be change is [`commitlint.config.js`](/commitlint.config.js)

0 comments on commit 533648d

Please sign in to comment.