Skip to content

Commit 143e540

Browse files
committed
update readme
1 parent 98ae4df commit 143e540

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

README.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
11
# codex-ui
22
A collection of ui components for bootstrap 4
33

4+
[![License](https://img.shields.io/badge/license-MIT-blue.svg)]()
5+
[![# of Components](https://img.shields.io/badge/total%20components-15-green.svg)]()
6+
47
![Item Previews](imgs/item-previews.png)
58

69
## View Components
710

811
To view a full list of components that are both done and on the road map simply go to [https://shadowcodex.github.io/codex-ui/components/](https://shadowcodex.github.io/codex-ui/components/)
912

13+
## How To Use
14+
15+
Just copy and paste. Each component will have a `code:` section below it. Just copy that code and paste it into your site. As long as you have bootstrap 4 running on the site, they components should just "work".
16+
17+
If they don't and you can't figure out why open an issue and I'll gladly help as much as I can!
18+
1019
## Restrictions
1120

1221
I am working off of two premiss for this UI library / Kit.
@@ -18,4 +27,19 @@ All components should basically be copy and paste for sites that use Bootstrap 4
1827

1928
The one, ONE, caveat to that right now is font awesome. I require some sort of icons for certain components, and since font awesome is one of the easiest to just drop in I am using that. Feel free to replace the icons with your own icon framework.
2029

21-
If a component does require font awesome it will be notated at the very top of that components page.
30+
If a component does require font awesome it will be notated at the very top of that components page.
31+
32+
## Contributions
33+
34+
I am open to contributions to the components, you could contribute in many ways:
35+
36+
1. Create a new component
37+
2. Request a new component
38+
3. Post bugs as issues
39+
4. Help answer issues as they come up
40+
41+
Any new components or pull requests will be reviewed to make sure they fit the restrictions before pulling them into the repo.
42+
43+
#### Built with :heart: by [shadowcodex](https://shadowcodex.github.io)
44+
45+
[![Twitter Follow](https://img.shields.io/twitter/follow/iammrduncan.svg?style=social&label=Follow)]()

0 commit comments

Comments
 (0)