pint/docs/README.md

57 lines
2.2 KiB
Markdown
Raw Normal View History

2022-07-07 04:24:38 +00:00
# <a href="https://projects.fuwa.sh/pint/"><img align="left" height="100" src="/docs/assets/pint-logo.png"/></a> **pint** (formerly gitccentify)
![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-12 05:05:33 +00:00
###### Traveller Information: You are on the main dev't branch. Things break here. For latest stable check branch 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-12 05:05:33 +00:00
![pintpreview](https://go.fuwa.sh/u/ufuvwg.png)
2022-07-07 04:24:38 +00:00
<br>
<br>
2022-07-12 05:05:33 +00:00
## installation
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
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
1. clone this repository
2. run `yarn build` or `yabai`
3. open extension settings in chrome/brave/chromium
4. turn on developer mode
5. load unpacked extension
6. load the build folder
2022-07-07 04:24:38 +00:00
2022-07-12 05:05:33 +00:00
## roadmap
please check #12.
2022-07-07 04:24:38 +00:00
2022-07-12 05:05:33 +00:00
## contributing
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.