Skip to content

Commit

Permalink
Minor improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
T-Dynamos authored Mar 13, 2024
1 parent 5e031d6 commit b34f3d8
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ It is built in reference with offical [typescript implementation](https://github

## Features

1. Up to date with `material-foundation/material-color-utilities/`.
1. Up to date with `material-foundation/material-color-utilities`.
2. Uses official c++ sources for quantization backend, which makes color generation fast!

## Minimal running example:
Expand All @@ -30,7 +30,9 @@ Maximum quality is `1` that means use all pixels, and quality number more than `
</details>


## Install
## Usage

### Install

You can easily install it from pip by executing:
```console
Expand All @@ -39,15 +41,15 @@ pip3 install materialyoucolor --upgrade
Prebuilt binaries are avaliable for `linux`, `windows` and `macos`. If prebuilt binaries aren't available, then you should manually build and install.


## Build and install
### Build and install

```console
# Install
pip3 install https://github.com/T-Dynamos/materialyoucolor-python/archive/master.zip

```

## Usage with Android (kivy's buildozer)
### Usage with Android (kivy's buildozer)

Ensure these lines in `buildozer.spec`:
```python
Expand All @@ -56,7 +58,9 @@ p4a.branch = develop
```

## Usage examples

<details>
<summary> Click to show </summary>

- Generate non dynamic colors

```python
Expand Down Expand Up @@ -139,6 +143,7 @@ print(Score.score(result))
# list of selected colors in integer form

```
</details>

## FAQ

Expand Down

0 comments on commit b34f3d8

Please sign in to comment.