From 5ba9b4c0969952a5ccc4f5ab6784afa556eba081 Mon Sep 17 00:00:00 2001 From: Florian Forster Date: Thu, 19 Mar 2020 15:19:18 +0100 Subject: [PATCH] docs(readme): initiate boilerplate (#18) * docs(readme): initiate boilerplate * Update README.md Co-Authored-By: livio-a Co-authored-by: livio-a --- README.md | 27 ++++++++++++++++++++++++--- 1 file changed, 24 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 546361b2d..3ee954f4a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,28 @@ -# zitadel +# Zitadel -![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg) +[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) ![Release Badge](https://github.com/caos/zitadel/workflows/Test,%20Build,%20Release/badge.svg) [![GitHub license](https://img.shields.io/github/license/caos/zitadel)](https://github.com/caos/zitadel/blob/master/LICENSE) -[![GitHub release](https://img.shields.io/github/release/caos/zitadel)](https://github.com/caos/zitadel/releases/) +[![GitHub release](https://img.shields.io/github/release/caos/zitadel)](https://gitHub.com/caos/zitadel/releases/) +> This project is in alpha state. The API will continue breaking until version 1.0.0 is released + +## What Is It + +It will be an IAM ;-) + +## How Does It Work + +## Why Another IAM + +## How To Use It + +## How To Contribute + +TBD + +## License + +See the exact licensing terms [here](./LICENSE) + +Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.