From 61c6922638c2c7a4870d552cca1b324a377d44d4 Mon Sep 17 00:00:00 2001 From: Jariel Que Date: Tue, 26 Jul 2022 17:34:18 +0800 Subject: [PATCH] docs: make readme look good --- docs/README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/README.md b/docs/README.md index 34db678..9010e64 100644 --- a/docs/README.md +++ b/docs/README.md @@ -8,7 +8,7 @@
-###### Traveller Information: You are on the main dev't branch. Things break here. For latest stable check branch v1. +> 💡 You are currently looking at the rebranded version of pint which is currently unreleased, the released one is located [here](https://github.com/fuwaa/pint/tree/v1) [pint](https://projects.fuwa.sh/pint/) is a theming engine that allows you to rice your github experience. @@ -21,8 +21,7 @@ you can install this extension via the chrome web store (old version) or manually. ### chrome web store installation - -please note that the version in the chrome web store is V1, which is very bad and outdated. +> ⚠️ Please note that the version in the chrome web store is V1, which is very bad and outdated. @@ -37,7 +36,15 @@ please note that the version in the chrome web store is V1, which is very bad an ## roadmap -please check #12. +please check issue [#12](https://github.com/fuwaa/pint/issues/12) for more information :) + +## limitations +> 💡 I am still looking for ways to better implement this! if you have any idea, please open an issue or create a pull request [here](https://github.com/fuwaa/pint/issues/new/choose) + +The old implementation used a `setTimeout()` function, however the delay makes the project look like garbage as you can see the original colors before seeing your palette applied. The new implementation simply throws the entire css of github and unsets it while hiding the entire html making github look like an empty page until your palette gets loaded. Slight issue though, a flicker comes from time to time but it isn't noticable. + +## documentation +Documentation is planned to debut on [fuwadocs](https://docs.fuwa.sh/pint/), however it is still in progress and is quite low on the priority queue. ## contributing