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: update readme

Browse source
This commit is contained in:
Jariel Que 2022-08-03 13:27:11 +08:00 committed by GitHub
parent d46ac94a9c
commit 79edc0a4b2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/README.md
View file

@ -1,8 +1,6 @@
# <a href="https://projects.fuwa.sh/pint/"><img align="left" height="100" src="/docs/assets/pint-logo.png"/></a> **pint** (formerly gitccentify) # <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%20src-2.0-green)
![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-version](https://img.shields.io/chrome-web-store/v/mjhmdkcefcklflcmmokoahfdodcpeobg)
![chrome-web-store-users](https://img.shields.io/chrome-web-store/users/mjhmdkcefcklflcmmokoahfdodcpeobg) ![chrome-web-store-users](https://img.shields.io/chrome-web-store/users/mjhmdkcefcklflcmmokoahfdodcpeobg)
@ -10,9 +8,10 @@
> 💡 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) > 💡 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. [pint](https://projects.fuwa.sh/pint/) is a theming engine that allows you to theme your github experience.
![image](https://user-images.githubusercontent.com/53419401/182528225-8f1b8d54-2e7a-4a5c-a8de-6671e7585dc6.png)
![image](https://user-images.githubusercontent.com/53419401/180970561-02cc824d-f4e5-4935-97f0-560d3860b05a.png)
<br> <br>
<br> <br>
@ -22,14 +21,12 @@ you can install this extension via the chrome web store (old version) or manuall
### chrome web store installation ### chrome web store installation
> ⚠️ 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> <a href="https://chrome.google.com/webstore/detail/gitccentify/mjhmdkcefcklflcmmokoahfdodcpeobg"><img src="https://storage.googleapis.com/web-dev-uploads/image/WlD8wC6g8khYWPJUsQceQkhXSlv1/UV4C4ybeBTsZt43U4xis.png" /></a>
### manual/source installation ### manual/source installation
1. clone this repository 1. clone this repository
2. run `yarn build` or `yabai` 2. run `yarn build`
3. open extension settings in chrome/brave/chromium 3. open extension settings in chrome/brave/chromium
4. turn on developer mode 4. turn on developer mode
5. load unpacked extension 5. load unpacked extension
@ -37,7 +34,9 @@ you can install this extension via the chrome web store (old version) or manuall
## roadmap ## roadmap
please check issue [#12](https://github.com/fuwaa/pint/issues/12) for more information :) please check [issues](https://github.com/fuwaa/pint/issues) for planned aditions, feature requests, bugs and more information.
alternatively, you can also open a [new issue](https://github.com/fuwaa/pint/issues/new) to add to it!
## limitations ## limitations
@ -51,7 +50,7 @@ Documentation is planned to debut on [fuwadocs](https://docs.fuwa.sh/pint/), how
## contributing ## contributing
contributions are welcome ❤️. however, please do keep in mind that this is a very early project and things are bound to be messy. while code quality is my top priority, i'm currently implementing it ever so slowly. contributions are welcome ❤️. however, please do keep in mind that this is a very early project and things are bound to be [messy](https://github.com/fuwaa/pint/issues/37). while code quality is my top priority, i'm implementing it as i go (which is a bit slow since I'm porting this myself to typescript) and would appreciate help regarding it so we could learn more from it too.
## project structure ## project structure
[![Structure](https://images.repography.com/27896465/fuwaa/pint/structure/a993ba4f490beac88c1084429e54e710_table.svg)](https://github.com/fuwaa/pint) [![Structure](https://images.repography.com/27896465/fuwaa/pint/structure/a993ba4f490beac88c1084429e54e710_table.svg)](https://github.com/fuwaa/pint)