Skip to content

Commit

Permalink
deprecation notice
Browse files Browse the repository at this point in the history
  • Loading branch information
Flooflez authored Jul 28, 2024
1 parent e9a27f8 commit 5b0e242
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
![Ngrok LAN Banner](https://github.com/Alujjdnd/Ngrok-LAN/blob/1.18.2/docs/assets/banner.png?raw=true)
<h1 align="center"> <a href="https://github.com/Alujjdnd/Ngrok-LAN/blob/1.20/IMPORTANT.md">DEPRECATION NOTICE</a> </h1>





![Ngrok LAN Banner](https://github.com/Alujjdnd/Ngrok-LAN/blob/main/docs/assets/banner.png?raw=true)

<h1 align="center">
Ngrok LAN
Expand All @@ -11,12 +17,9 @@
<a href="https://www.codacy.com/gh/Alujjdnd/Ngrok-LAN/dashboard?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=Alujjdnd/Ngrok-LAN&amp;utm_campaign=Badge_Grade"><img src="https://app.codacy.com/project/badge/Grade/b38f7148f2934ad8b6d4413b70a173fd"/></a>
<img alt="GitHub commit activity" src="https://img.shields.io/github/commit-activity/m/alujjdnd/ngrok-lan">
</br>
<img src=https://raw.githubusercontent.com/Alujjdnd/Ngrok-LAN/1.18.2/docs/assets/OSSrs.png>
<img src=https://raw.githubusercontent.com/Alujjdnd/Ngrok-LAN/main/docs/assets/OSSrs.png>
</div>

## Help Needed!
We are trying to port this mod to QuiltMC, many thanks to those who have contributed already! However, we are hope that a Quilt specific config library will become available to use soon, since our mod requires editing a config file we want the process to be as easy as possible for our users.

## Introduction
Ngrok LAN is a Fabric mod that enables you to share your singleplayer world with your friends across the globe, all via
clicking on the new "Open Public Server" button! This mod uses Ngrok, a free service to ease the creation of servers, as
Expand All @@ -26,7 +29,7 @@ after you click on "Open Public Server".
For more on how Ngrok-LAN works, check out [What is Ngrok](#what-is-ngrok).

<div align="center">
<img src="https://raw.githubusercontent.com/Alujjdnd/Ngrok-LAN/1.18.2/docs/assets/demo.gif" alt="Network Diagram" width="70%"/>
<img src="https://raw.githubusercontent.com/Alujjdnd/Ngrok-LAN/main/docs/assets/demo.gif" alt="Network Diagram" width="70%"/>
</div>

# Installation/Quick Start
Expand Down Expand Up @@ -129,7 +132,7 @@ friends to connect to our server. This doesn't require any other configuration o
internet, and an Ngrok account, you can host your singleplayer world to your friends across the globe.

<div align="center">
<img src="https://raw.githubusercontent.com/Alujjdnd/Ngrok-LAN/1.18.2/docs/assets/Network.jpg" alt="Network Diagram" width="80%"/>
<img src="https://raw.githubusercontent.com/Alujjdnd/Ngrok-LAN/main/docs/assets/Network.jpg" alt="Network Diagram" width="80%"/>
</div>

## Ngrok Account Requirements
Expand All @@ -149,6 +152,7 @@ Please refer to [Incompatibilities](https://github.com/Alujjdnd/Ngrok-LAN/labels

- Port to QuiltMC (Please reach out and help us!)
- 1.17.1 Build
- Add Whitelist and Blacklist Functionality

# License

Expand Down

0 comments on commit 5b0e242

Please sign in to comment.