https://github.com/theapache64/name-that-color
A library to name hex color codes
https://github.com/theapache64/name-that-color
Last synced: about 1 year ago
JSON representation
A library to name hex color codes
- Host: GitHub
- URL: https://github.com/theapache64/name-that-color
- Owner: theapache64
- License: apache-2.0
- Created: 2021-02-09T21:33:25.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-10T06:18:11.000Z (about 5 years ago)
- Last Synced: 2025-02-01T17:44:00.426Z (about 1 year ago)
- Language: Kotlin
- Homepage:
- Size: 241 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# name-that-color
> A library to name hex color codes
## 🦿 Prerequisites
Add `jitpack` to your `repositories`
```groovy
maven { url "https://jitpack.io" }
```
## 🛠 Installation
```groovy
implementation 'com.github.theapache64:name-that-color:'
```
## ⌨️ Usage
```kotlin
ColorNameFinder.findColor(HexColor("#000000")) // Black
ColorNameFinder.findColor(HexColor("#4169e1")) // Royal Blue
ColorNameFinder.findColor(HexColor("#2c4f03")) // Verdun Green
ColorNameFinder.findColor(HexColor("#f00")) // Red
```
To see more usage, see [tests](src/test/kotlin/com/github/theapache64/namethatcolor)
## 🥼 Run tests
```shell script
./gradlew test
```
## 🤗 Credits
- Thanks to [@galex](https://twitter.com/galex) for
porting [chir.ag/name-that-color](https://chir.ag/projects/name-that-color/)'s JS library to Kotlin
All credit goes to [chir.ag](http://chir.ag) and [galex](https://github.com/galex)
## ✍️ Author
👤 **theapache64**
* Twitter: @theapache64
* Email: theapache64@gmail.com
Feel free to ping me 😉
## 🤝 Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any
contributions you make are **greatly appreciated**.
1. Open an issue first to discuss what you would like to change.
1. Fork the Project
1. Create your feature branch (`git checkout -b feature/amazing-feature`)
1. Commit your changes (`git commit -m 'Add some amazing feature'`)
1. Push to the branch (`git push origin feature/amazing-feature`)
1. Open a pull request
Please make sure to update tests as appropriate.
## ❤ Show your support
Give a ⭐️ if this project helped you!
## 📝 License
```
Copyright © 2021 - theapache64
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
_This README was generated by [readgen](https://github.com/theapache64/readgen)_ ❤