Skip to content

Commit

Permalink
docs(README): add initial README.md file
Browse files Browse the repository at this point in the history
  • Loading branch information
supitsdu committed Mar 9, 2024
1 parent c70e3f0 commit e119fc5
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions README.md
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.

0 comments on commit e119fc5

Please sign in to comment.