pint/docs/README.md

65 lines
3.2 KiB
Markdown
Raw Normal View History

2022-07-12 05:41:53 +00:00
# <a href="https://projects.fuwa.sh/pint/"><img align="left" height="100" src="/docs/assets/pint-logo.png"/></a> **pint** (formerly gitccentify)
2022-07-07 04:24:38 +00:00
![rewrite-status](https://img.shields.io/badge/status-rewrite-orange)
![pint-status](https://img.shields.io/badge/pint-dev-red)
![gitccentify-status](https://img.shields.io/badge/gitccentify-released-green)
![chrome-web-store-version](https://img.shields.io/chrome-web-store/v/mjhmdkcefcklflcmmokoahfdodcpeobg)
![chrome-web-store-users](https://img.shields.io/chrome-web-store/users/mjhmdkcefcklflcmmokoahfdodcpeobg)
<hr>
2022-07-26 09:34:18 +00:00
> 💡 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)
2022-07-07 04:24:38 +00:00
2022-07-12 05:05:33 +00:00
[pint](https://projects.fuwa.sh/pint/) is a theming engine that allows you to rice your github experience.
2022-07-07 04:24:38 +00:00
2022-07-26 09:14:35 +00:00
![image](https://user-images.githubusercontent.com/53419401/180970561-02cc824d-f4e5-4935-97f0-560d3860b05a.png)
2022-07-07 04:24:38 +00:00
<br>
<br>
2022-07-12 05:05:33 +00:00
## installation
2022-07-12 05:41:53 +00:00
2022-07-12 05:05:33 +00:00
you can install this extension via the chrome web store (old version) or manually.
2022-07-07 04:24:38 +00:00
2022-07-12 05:05:33 +00:00
### chrome web store installation
2022-07-26 09:34:18 +00:00
> ⚠️ Please note that the version in the chrome web store is V1, which is very bad and outdated.
2022-07-07 04:24:38 +00:00
2022-07-12 05:19:19 +00:00
<a href="https://chrome.google.com/webstore/detail/gitccentify/mjhmdkcefcklflcmmokoahfdodcpeobg"><img src="https://storage.googleapis.com/web-dev-uploads/image/WlD8wC6g8khYWPJUsQceQkhXSlv1/UV4C4ybeBTsZt43U4xis.png" /></a>
2022-07-07 04:24:38 +00:00
2022-07-12 05:05:33 +00:00
### manual/source installation
2022-07-12 05:41:53 +00:00
2022-07-12 05:05:33 +00:00
1. clone this repository
2. run `yarn build` or `yabai`
3. open extension settings in chrome/brave/chromium
4. turn on developer mode
2022-07-12 05:41:53 +00:00
5. load unpacked extension
2022-07-12 05:05:33 +00:00
6. load the build folder
2022-07-07 04:24:38 +00:00
2022-07-12 05:05:33 +00:00
## roadmap
2022-07-26 09:34:18 +00:00
please check issue [#12](https://github.com/fuwaa/pint/issues/12) for more information :)
## limitations
2022-07-26 09:34:18 +00:00
> 💡 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
2022-07-26 09:34:18 +00:00
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.
2022-07-12 05:05:33 +00:00
## contributing
2022-07-12 05:41:53 +00:00
2022-07-12 05:05:33 +00:00
contributions are welcome ❤️. however, please do keep in mind that this is a very early project and things are bound to be messy. i mean just look at these linting errors.
<br><br>
![lintlmao](https://go.fuwa.sh/u/9eTsWq.png)
2022-07-07 04:24:38 +00:00
<p align="center"><br><a href="https://projects.fuwa.sh/pint"><img height="25" src="/docs/assets/pint-logo.png"/></a><br><a href="https://projects.fuwa.sh/pint">pint</a> • by <a href="https://fuwa.sh">fuwaa</a></p>
<hr>
###### This extension is licensed under the GPLv3 License.
2022-07-07 10:22:40 +00:00
###### This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with GitHub, Inc. and Git, or any of its subsidiaries or its affiliates.