ryanamay/pint
1
0
Fork 0
mirror of https://github.com/ryanamay/pint.git synced 2024-09-20 01:50:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: make readme look good

Browse source
This commit is contained in:
Jariel Que 2022-07-26 17:34:18 +08:00 committed by GitHub
parent 4eeba6d7d8
commit 61c6922638
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
docs/README.md
View file

@ -8,7 +8,7 @@
<hr>
###### 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.
<a href="https://chrome.google.com/webstore/detail/gitccentify/mjhmdkcefcklflcmmokoahfdodcpeobg"><img src="https://storage.googleapis.com/web-dev-uploads/image/WlD8wC6g8khYWPJUsQceQkhXSlv1/UV4C4ybeBTsZt43U4xis.png" /></a>
@ -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