Skip to content

Commit a228332

Browse files
committed
Clean up readme
1 parent cdd0b97 commit a228332

File tree

1 file changed

+3
-23
lines changed

1 file changed

+3
-23
lines changed

README.md

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,18 @@
11
![OneConfig_banner_wide](https://user-images.githubusercontent.com/62163840/226811571-ffe7a524-c96a-4b6e-9ca9-d29439f5174f.png)
22

3-
# This README is wildly outdated for V1. We will be writing docs soon. For a quick and dirty migration guide, see https://docsv1.polyfrost.org/temporary-v0-greater-than-v1-migration-guide
4-
53
# OneConfig
6-
![Dev Worflow Status](https://img.shields.io/github/actions/workflow/status/Polyfrost/OneConfig/release.yml?style=for-the-badge&color=1452cc&label=release)
7-
![Dev Worflow Status](https://img.shields.io/github/actions/workflow/status/Polyfrost/OneConfig/build.yml?style=for-the-badge&color=1452cc&label=build)
4+
![Dev Workflow Status](https://img.shields.io/github/actions/workflow/status/Polyfrost/OneConfig/release.yml?style=for-the-badge&color=1452cc&label=release)
5+
![Dev Workflow Status](https://img.shields.io/github/actions/workflow/status/Polyfrost/OneConfig/build.yml?style=for-the-badge&color=1452cc&label=build)
86

97
OneConfig is a free, open sourced configuration library by [Polyfrost](https://polyfrost.org), designed to give developers a simple config API, which users can interact with in an elegant user interface.
108

119
## ❔ General information
1210

13-
<details>
14-
<summary>Click to view screenshots</summary>
15-
<img src="https://user-images.githubusercontent.com/62163840/226493559-8cf2e7a9-99fe-4388-a479-8463132260ac.png">
16-
<img src="https://user-images.githubusercontent.com/62163840/196335017-0ef66813-1500-4279-a6b1-565ec0741816.png">
17-
<img src="https://user-images.githubusercontent.com/62163840/196335021-2df9bf19-d8d8-4872-ac57-1f6a53769cdd.png">
18-
<img src="https://user-images.githubusercontent.com/62163840/196335012-9c0f098e-4214-42cf-a83a-9bcbe65a240b.png">
19-
</details>
20-
21-
### Installation:
22-
For beginners, we recommend using [SkyClient](https://skyclient.co/), a free and open-sourced mod installer. For more technical users, all of our mods, including [Hytils](https://github.com/Polyfrost/Hytils-Reborn), [CrashPatch](https://github.com/Polyfrost/crashpatch), [EvergreenHUD](https://github.com/Polyfrost/EvergreenHUD), and [Chatting](https://github.com/Polyfrost/chatting) have full support, and come with OneConfig. Most of your existing mods (i.e. ones that use [Vigilance](https://github.com/EssentialGG/Vigilance)) are also supported through our [compatability layer](https://docs.polyfrost.org/oneconfig/config/compatibility).
23-
2411
### Is it a client?
2512
While it may look like OneConfig is a client, in reality it's actually a standalone mod. You can actually [see for yourself](https://github.com/Polyfrost/OneConfig-Bootstrap), it doesn't come with any mods of it's own. It's left up to the user to decide which mods they want to actually use.
2613

27-
2814
## ⚡️ Getting started
29-
Almost everything you could need to start using OneConfig can be found in [our documentation](https://docs.polyfrost.org). For further questions, feel free to make a developer ticket in [our discord](https://polyfrost.org/discord).
30-
31-
- Start a new project with our [mod template](https://github.com/Polyfrost/OneConfigExampleMod/), add OneConfig to an [existing project](https://docs.polyfrost.org/oneconfig/getting-started), or [migrate](https://docs.polyfrost.org/oneconfig/config/compatibility) from ``JSON``, ``Vigilance``, or ``.cfg`` (Forge) files.
32-
- [Register a config](https://docs.polyfrost.org/oneconfig/config/creating-a-config)
33-
- [Add config options](https://docs.polyfrost.org/oneconfig/config/adding-options)
34-
- [HUD system](https://docs.polyfrost.org/oneconfig/huds/creating-a-hud)
35-
- Check out other [utilities](https://docs.polyfrost.org/oneconfig/utils/oneconfigs-utilities) like [events](https://docs.polyfrost.org/oneconfig/events/event-basics), [commands](https://docs.polyfrost.org/oneconfig/commands/commands), and [custom rendering](https://docs.polyfrost.org/oneconfig/gui/render-manager).
15+
### Almost everything you could need to start using OneConfig can be found in [our documentation](https://docsv1.polyfrost.org). For further questions, feel free to make a developer ticket in [our discord](https://polyfrost.org/discord).
3616

3717
## ℹ️ Example mod
3818
Please check out our [example mod](https://github.com/Polyfrost/OneConfigExampleMod/).

0 commit comments

Comments
 (0)