Add Readme.md

2021-05-25 17:13:20 +02:00 · 2021-05-25 17:13:20 +02:00 · 153aeeca12
commit 153aeeca12
parent 1d1b5751b9
1 changed files with 69 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,69 @@
+# Wir.Social Deploys And Rebrands Ocelot.Social
+
+This repository is used to rebrand, configure, and deploy the [wir.social](https://wir.social) networks.
+The forked original repository is [Ocelot-Social-Deploy-Rebranding](https://github.com/Ocelot-Social-Community/Ocelot-Social-Deploy-Rebranding).
+
+<!-- [![Build Status](https://travis-ci.com/Human-Connection/Human-Connection.svg?branch=master)](https://travis-ci.com/Human-Connection/Human-Connection) -->
+<!-- [![Codecov Coverage](https://img.shields.io/codecov/c/github/Human-Connection/Human-Connection/master.svg?style=flat-square)](https://codecov.io/gh/Human-Connection/Human-Connection/) -->
+<!-- [![MIT License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/Human-Connection/Nitro-Backend/blob/backend/LICENSE.md) -->
+<!-- [![Discord Channel](https://img.shields.io/discord/489522408076738561.svg)](https://discordapp.com/invite/DFSjPaX) -->
+<!-- [![Open Source Helpers](https://www.codetriage.com/human-connection/human-connection/badges/users.svg)](https://www.codetriage.com/human-connection/human-connection) -->
+
+<p align="center">
+  <img src="branding/static/img/custom/logo-squared.svg" alt="wir.social" width="40%" height="40%">
+</p>
+
+<!--
+## Live demo
+
+__Try out our deployed [development environment](https://develop.human-connection.org/).__
+
+Logins:
+
+| email | password | role |
+| :--- | :--- | :--- |
+| `user@example.org` | 1234 | user |
+| `moderator@example.org` | 1234 | moderator |
+| `admin@example.org` | 1234 | admin |
+-->
+
+<!--
+## Usage
+
+Fork this repository and configure as well as rebrand it for your own [ocelot.social](https://github.com/Ocelot-Social-Community/Ocelot-Social) network.
+
+- [Configure And Rebrand](https://github.com/Ocelot-Social-Community/Ocelot-Social-Deploy-Rebranding/tree/master/branding)
+
+Afterwards you can [deploy](deployment/README.md) it on your server:
+
+- [Kubernetes with Helm](deployment/kubernetes/README.md)
+-->
+
+## Developer Chat
+
+Join our friendly open-source community on [Discord](https://discordapp.com/invite/DFSjPaX) :heart_eyes_cat:
+Just introduce yourself at `#introduce-yourself` and mention `@@Mentor` to get you onboard :neckbeard:
+Check out the [contribution guideline](https://github.com/Ocelot-Social-Community/Ocelot-Social/blob/master/CONTRIBUTING.md), too!
+
+We give write permissions to every developer who asks for it. Just text us on
+[Discord](https://discord.gg/6ub73U3).
+
+## Technology Stack
+
+- [Kubernetes](https://kubernetes.io)
+- [Helm](https://helm.sh)
+- [Docker](https://www.docker.com)
+
+<!--
+## Attributions
+
+Locale Icons made by [Freepik](http://www.freepik.com/) from [www.flaticon.com](https://www.flaticon.com/) is licensed by [CC 3.0 BY](http://creativecommons.org/licenses/by/3.0/).
+
+Browser compatibility testing with [BrowserStack](https://www.browserstack.com/).
+
+<img alt="BrowserStack Logo" src=".gitbook/assets/browserstack-logo.svg" width="256">
+-->
+
+## License
+
+See the [LICENSE](LICENSE.md) file for license rights and limitations (MIT).