Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/twbs/icons.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMark Otto <markdotto@gmail.com>2019-08-01 00:38:59 +0300
committerMark Otto <markdotto@gmail.com>2019-08-01 00:38:59 +0300
commitb2910ff4c95bbb7b368557b608660766e41be5be (patch)
treebe26e6fd13a5836def54c0fd7b76c5c8e4bf8910 /README.md
parentbfcab7d3518464c171e69cf0b9305905c76eb5bb (diff)
Readme, svgo script
Diffstat (limited to 'README.md')
-rw-r--r--README.md36
1 files changed, 35 insertions, 1 deletions
diff --git a/README.md b/README.md
index 9d8317851..14379165f 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,35 @@
-# Bootstrap icons
+<p align="center">
+ <a href="https://getbootstrap.com/">
+ <img src="https://getbootstrap.com/docs/4.3/assets/brand/bootstrap-solid.svg" alt="Bootstrap logo" width="72" height="72">
+ </a>
+</p>
+
+<h3 align="center">Bootstrap Icons</h3>
+
+<p align="center">
+ Official open source icon library for Bootstrap.
+ <br>
+ <a href="https://icons.getbootstrap.com/"><strong>Explore Bootstrap Icons »</strong></a>
+ <br>
+ <br>
+ <a href="https://getbootstrap.com/docs/4.3/">Bootstrap</a>
+ ·
+ <a href="https://themes.getbootstrap.com/">Themes</a>
+ ·
+ <a href="https://blog.getbootstrap.com/">Blog</a>
+</p>
+
+## Install
+
+```
+npm i bootstrap-icons --save
+```
+
+## Todos
+
+Help wanted if you have ideas how to tackle these!
+
+- [ ] Update readme with install and usage guidelines
+- [ ] Add npm script for reprocessing icons (HTML, attribute order, generate class names)
+- [ ] Add copy to clipboard for SVG code in the docs
+- [ ] Alternate distribution and usage methods (e.g., JS library, React components, etc)