Improve the readme

This commit is contained in:
Jean-Baptiste Emmanuel Zorg 2024-02-17 19:02:49 +01:00
parent c638f4c834
commit 4c5a321738

View file

@ -1,19 +1,26 @@
# Bondage College
# Bondage College & Bondage Club
[![Asset Check](https://github.com/Ben987/Bondage-College/actions/workflows/assetCheck.yml/badge.svg)](https://github.com/Ben987/Bondage-College/actions/workflows/assetCheck.yml)
[![Lint](https://github.com/Ben987/Bondage-College/actions/workflows/lint.yml/badge.svg)](https://github.com/Ben987/Bondage-College/actions/workflows/lint.yml)
[![CI](https://gitgud.io/BondageProjects/Bondage-College/badges/master/pipeline.svg?ignore_skipped=true)](https://gitgud.io/BondageProjects/Bondage-College/-/blob/master/.gitlab-ci.yml)
Welcome to the Bondage College!
Welcome to the Bondage College!
This project is a Javascript/HTML5 game that contains adult themes such as BDSM.
It's pretty simple and there's no real goal, you play a new student on her first
day in a kinky college. There's lots of things to try and many possible outcomes
so be curious and kinky!
It's pretty simple and there's no real goal, you play a new student on her first day in a kinky college.
The (aptly-named) `BondageClub` folder is where the code for the Bondage Club
lives; the multiplayer-enabled game that you can join at the end of the Bondage
College storyline. Those are two separate games, but share a repository for
historical reasons.
There's lots of things to try and many possible outcomes so be curious and kinky!
It's free to download locally but please don't distribute it or publish it without
Ben987's consent.
It's free to download locally but please don't distribute it or publish it without Ben987 consent.
You can also add content to the game or correct errors if you want, simply fork
the repository, work on it and create a merge request!
You can also add content to the game or correct errors if you want, simply create pull requests.
## Additional resources
Here's a step by step tutorial on how to use [Git](https://docs.google.com/document/d/1wA_pcIWR105JU-o--U93Qrygtwqjc5IGWGCx9Qhw85c/edit) to contribute.