Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
MaksyKun authored Dec 21, 2023
1 parent 4af5325 commit 6441559
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: Home
layout: default
---

[![Build Status](https://travis-ci.org/pages-themes/minimal.svg?branch=master)](https://travis-ci.org/pages-themes/minimal)

<img src="img/logo.png" alt="Cyberpunk Breach Protocoll">

# BreachProtocol
BreachProtcol is an API to reconstruct breach puzzles that are based on Cyberpunk 2077.
The API allows you to place a breach-window based on JFrame between two transactions
in Java code in order to have to solve it before the code is executed further.
This is done using intercepted "BreachEvents", which will be explained again later.
## Project is W.I.P
This project has no mature reliability yet. The goal of it is to create an open-source fan-made breach-protocol that can
be used in any type of java-applications. Since I lack on some knowledge about git itself, there wont be a maven dependency so far.
However, once everything is working properly, Ill think about doing one.

Feel free to contribute to work together on a completely fictional & hopefully fun project.


If you're interested to hear about my approach of this project, DM me under Discord: maksykun

## Further Documentation
If you'd like to see the progress of this api you will be most-likely able to do it through the
documentation. The sidebar shows a slightly overview of the functionality yet.

0 comments on commit 6441559

Please sign in to comment.