Skip to content

Commit 14fa37f

Browse files
committedApr 5, 2023
added new info and screenshots to readme
1 parent 49b8c95 commit 14fa37f

File tree

3 files changed

+32
-23
lines changed

3 files changed

+32
-23
lines changed
 
Loading
Loading

‎readme.md

+32-23
Original file line numberDiff line numberDiff line change
@@ -4,55 +4,64 @@ onyx is a color tool made for software designers and developers — people w
44

55
the purpose of onyx is to provide you with a way to easily create and generate custom color palettes that you can use in a variety of contexts. onyx can be your full service color tool for any kind of chromatics-related research and development.
66

7-
designing an app and need some color inspiration? onyx can do that. want to convert colors from one format to another? onyx does that too! the list goes on — you'll never need another color app.
7+
designing an app and need some color inspiration? onyx can do that. want to convert colors from one format to another? onyx does that too! the list goes on — you'll never need another color app. maybe.
88

9-
onyx was created with the comfort and enjoyment of the user in mind.
9+
onyx was created with the comfort and enjoyment of the user in mind. if you think some feature doesn't feel intuitive, or some workflow is awkward, please let me know. I try to design interfaces that are fun and easy to use!
1010

11-
<hr>
11+
## how to use / download
1212

13-
## (indev) screenshots
13+
go to [jpegzilla.com/onyx](https://jpegzilla.com/onyx). if you're on a current version of chrome, edge, or safari, you should be prompted to download onyx as a [pwa](https://en.wikipedia.org/wiki/Progressive_web_app). otherwise, you can't download it, but you can use the online version as long as you have internet.
1414

15-
![onyx color animation](development-screenshots/3632ac531b8e4046ac573c4ddc3e4e54.gif)
15+
## features
1616

17-
![onyx indev screenshot](development-screenshots/f9a1865eebfecb1f761291dff7a5ae5a.png)
17+
- convert colors into a variety of different formats
18+
- get data on similar colors from other palettes, such as pantone, behr, and crayola
19+
- offline-first - onyx doesn't store your data online, so you always have access and control
20+
- create and export palettes in several different formats for sharing or use in other software, including adobe software
21+
- get contrast data in wcag2 and acpa forms
1822

1923
<hr>
2024

21-
## development
25+
## screenshots
2226

23-
while onyx is still in development, you can run it by downloading this repository and running [serve](https://www.npmjs.com/package/serve) or something like `python3 -m http.server` in the directory.
27+
![onyx screenshot](development-screenshots/116b2204a927debec9f1b0fcc11e7747.png)
2428

25-
## features
29+
![onyx screenshot](development-screenshots/fe483e8db9669587dff0741cf7e22e6f.png)
2630

27-
- convert colors into a variety of different formats
28-
- get data on similar colors from other palettes, such as pantone, behr, and crayola
29-
- offline-first - onyx doesn't store your data online, so you always have access and control
31+
![onyx color animation](development-screenshots/3632ac531b8e4046ac573c4ddc3e4e54.gif)
32+
33+
<hr>
3034

31-
## (upcoming) features
35+
## upcoming features
3236

3337
**onyx is still in development - features are incomplete.**
3438

35-
- three color selector control modes &mdash; choose between hsl, rgb, and hex
36-
- generate full palettes with the click of a button &mdash; with fine-tuned generation options
37-
- create palettes one color at a time for maximum freedom
39+
- three color slider control modes &mdash; choose between hsl, rgb, and lch
40+
- fine-tune palette generation options
3841
- see what your colors will look like on a rendered 3-dimensional shape
39-
- export palettes for adobe products, css code, and more
40-
- export and share palettes with other people who use onyx
42+
- visualize colors in various color spaces
4143
- create custom color workspaces to separate your palettes per project
4244
- drag and drop controls makes creating and organizing palettes easier
4345
- simulate color different types of color blindness with your palettes
46+
- improved keyboard controls for keyboard-only onyx usage
4447

45-
### contributing
46-
47-
_... tbd_
48-
49-
### also maybe coming
48+
_also maybe coming..._
5049

5150
- yiq, ycbcr, y'uv color
5251
- cieluv
5352
- customizable keyboard shortcuts
5453
- create palette from image
5554

55+
## why does this exist?
56+
57+
I use many color tools simultaneously when I'm doing interface design. creating a color palette often means I'll visit [monochrome](https://monochrome.jxnblk.com/), [colorable](https://colorable.jxnblk.com/), [contrast ratio](https://contrast-ratio.com/), [apca contrast calculator](https://www.myndex.com/APCA/), and even [coolors](https://coolors.co/generate).
58+
59+
I wanted to create one complete solution for everything I need when creating interface color palettes. onyx is the next step in my quest to achieve this goal, with the previous step being [emerald](https://jpegzilla.com/emerald).
60+
61+
## development
62+
63+
while onyx is still in development, you can run it by downloading this repository and running [serve](https://www.npmjs.com/package/serve) or something like `python3 -m http.server` in the directory.
64+
5665
### todo
5766

5867
- jsdoc literally everything

0 commit comments

Comments
 (0)
Please sign in to comment.