@@ -9,6 +9,8 @@ I would definitely advise against using this in any production projects. I have
99pretty minimal time to work on it, and it's mostly just a fun side project for
1010me (i.e. I cannot guarantee any level of support).
1111
12+ [ Click here to view the docs] ( https://gargrave.github.io/react-simple-select )
13+
1214## Getting Started
1315
1416- Install:
@@ -20,8 +22,27 @@ me (i.e. I cannot guarantee any level of support).
2022 most cases. (You can pass in custom styles to override the defaults if
2123 you wish.)
2224- Use the ` Select ` component in your project! A _ very_ rough example might
23- look something like this:
25+ look something like this. (Until I have better docs, you can take a look at my
26+ [ demo project] ( https://github.com/gargrave/react-simple-select-demo/blob/master/src/demo/DemoTS.tsx ) )
27+
28+ ## Todo
29+
30+ These are few items on my current road map, although I don't have any specific ETA:
31+
32+ - [ ] Better docs (see the section below)
33+ - [ ] Groupable options
34+ - [ ] Disabled options
35+ - [ ] Editable options (i.e. type to add a new option)
36+ - [ ] Multi-select
37+ - [ ] Accessibility
38+
39+ ## Docs
40+
41+ Right now (and for the foreseeable future), the docs are just my Styleguidist build.
42+ [ Click here to view the docs] ( https://gargrave.github.io/react-simple-select ) . They need
43+ a little touching up before they will be very useful, but that is on my short list.
44+
45+ ### Docs Todo
2446
25- ``` jsx
26- // TODO: Sorry! A better demo will be coming soon. I ran out of time! 😮
27- ```
47+ - [ ] Better code snippets for examples (snippets are hidden right now)
48+ - [ ] More examples for various props
0 commit comments