diff --git a/README.md b/README.md index 2ebc42a8b1..1ab5c53670 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,39 @@ -![Oculus: An open-source shaders mod compatible with OptiFine shaderpacks](banner.png) -[Discord](https://discord.gg/UCsyn5RS4s) \ No newline at end of file +
+ +
+ +# Oculus +[![](http://cf.way2muchnoise.eu/short_oculus_downloads.svg)](https://www.curseforge.com/minecraft/mc-mods/oculus) +[![](http://cf.way2muchnoise.eu/versions/Available%20for_oculus_full.svg)](https://www.curseforge.com/minecraft/mc-mods/oculus/files) + +Oculus is an Unofficial Fork of ["Iris"](https://www.curseforge.com/minecraft/mc-mods/irisshaders), made to work with Forge Mod Loader. + +## Disclaimer +Oculus is not and never will be compatible with Optifine! + +## Dependencies +Oculus requires [Rubidium](https://www.curseforge.com/minecraft/mc-mods/rubidium) made by Asek3! + +## Features +* Performance. Oculus should fully utilize your graphics card when paired with optimization mods like Rubidium. + +* Mod compatibility. Oculus should make a best effort to be compatible with modded environments. + +* Backwards compatibility. All existing ShadersMod / OptiFine shader packs should just work on Oculus, without any modifications required. + +* A well-organized codebase. I'd like for working with Oculus code to be a pleasant experience overall. + +## Discord +[![](https://dcbadge.vercel.app/api/server/UCsyn5RS4s)](https://discord.gg/UCsyn5RS4s) + +## Contributors + + + + +## License + +[LGPL-3.0 license](https://github.com/Asek3/Oculus/blob/1.16.5/LICENSE) + +## Consider supporting +[![Support me on Patreon](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Fshieldsio-patreon.vercel.app%2Fapi%3Fusername%3Dasek3%26type%3Dpatrons&style=for-the-badge)](https://patreon.com/asek3)