-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs(README): add initial README.md file
- Loading branch information
Showing
1 changed file
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Colorus | ||
|
||
A fluid JavaScript tool that simplifies color manipulation and supports a variety of color spaces. | ||
|
||
## Usage | ||
|
||
```js | ||
import Colorus from 'colorus' | ||
|
||
const color = new Colorus('#ff0014') // Create a color object with red shade. | ||
|
||
console.log(color.rgb) // Output: {r:255,g:0,b:20} | ||
console.log(color.toHex()) // Output: '#FF0014' | ||
``` | ||
|
||
## Contributing | ||
|
||
Contributions are welcomed! Feel free to fork the repository, make your changes, and submit a pull request. | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details. |