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-11-27 21:56:34 +0300
committerMark Otto <markdotto@gmail.com>2019-11-27 21:56:34 +0300
commitb6f2af00cd3188c696745fe9912c40b4bf574f34 (patch)
treea71adcb6f65d4b9e91070a0e1a927f2e06b9ef25 /README.md
parent69a682c8603d7aa5e676c4fb1beb13a63eb832c2 (diff)
update formatting, add figma link
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 10 insertions, 6 deletions
diff --git a/README.md b/README.md
index dcb4244fa..779cb51da 100644
--- a/README.md
+++ b/README.md
@@ -19,9 +19,13 @@
<a href="https://blog.getbootstrap.com/">Blog</a>
</p>
+# 200+ icons
+
![Bootstrap Icons full set](https://user-images.githubusercontent.com/98681/69751498-12224a80-1104-11ea-9dd6-6f162a8a2566.png)
-## Install
+[Also available in Figma.](https://www.figma.com/file/TPcq3YwYqNHNDV8WVfSjDY/Bootstrap-Icons-v1.0.0-alpha)
+
+# Install
Bootstrap Icons are packaged up and published to npm. We only include the processed SVGs in this package—it's up to you and your team to implement. [Read our docs](https://icons.getbootstrap.com/) at for usage instructions.
@@ -29,7 +33,7 @@ Bootstrap Icons are packaged up and published to npm. We only include the proces
npm i bootstrap-icons --save
```
-## Development
+# Development
[![Build Status](https://github.com/twbs/icons/workflows/Tests/badge.svg)](https://github.com/twbs/icons/actions?workflow=Tests)
@@ -44,7 +48,7 @@ npm start
Then open `http://localhost:4000` in your browser.
-## Adding SVGs
+# Adding SVGs
Once a new SVG icon has been added to the `icons` directory, you'll need to optimize them. An npm script is used to:
@@ -53,7 +57,7 @@ Once a new SVG icon has been added to the `icons` directory, you'll need to opti
Use `npm run icons` to run the script, then commit the results in a new branch for updating.
-## Publishing
+# Publishing
Docs are published via an npm script that builds the Hugo site, creates a temporary Git repo, and force pushes that to our `gh-pages` branch. This circumvents issues with GitHub Pages not working with Hugo.
@@ -61,10 +65,10 @@ Docs are published via an npm script that builds the Hugo site, creates a tempor
npm run publish
```
-## License
+# License
MIT
-## Author
+# Author
@mdo