jekyll-octicons 0.0.0.pre.5506537 → 0.0.0.pre.6471865

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ff967275be744819405bfbabffd79f517179d617cc01af0e56f4175cd65de04
-  data.tar.gz: 4a2cea1308574477677663f773400e563c732183580771b3379db8668ee1cacb
+  metadata.gz: 16820d955333b9b0ec2ddc0f74ef56288f01d7fa72620b1c917be1107f84192a
+  data.tar.gz: b0d3d0b8b3192d90782fc93a868c26a430c1e5f8a902d520881eb1ab6212d535
 SHA512:
-  metadata.gz: 6fce94335979f06d4d7676abdba7c04a251af9dfc4fcf3b2453ed5f04967cf13f15e21faa8bca76e6cc87856f348b9ea6f215f0952833324f41e211b9c348bcc
-  data.tar.gz: ff969f90c874bee33accd6c3a476e6b56c0b9de2f6df0a42facf5d4ae978cce48cda87a2bed9067627e2775362956a3dd565e4451c6829a16b148be898a53f5f
+  metadata.gz: 07deb5930a0acd9d47846f65057326ca20141ee962492eb61d7c761df28aa3a0e3cfab2ebabf45d444e63bbedf25611f25b0980849bc86d6a6a84d1c095d7340
+  data.tar.gz: 85283547dc95cf9c2ccb00c2a4cb96754b23b65b0b1aa6dee1f08feed061e3e216c65339a3afe98050058a591a35498cce572709106ca50f55b00c5dc4b9414c

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 GitHub Inc.
+Copyright (c) 2020 GitHub Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,5 +1,46 @@
-# jekyll-octicons
+# Octicons jekyll tag
 
 [![Gem version](https://img.shields.io/gem/v/jekyll-octicons.svg)](https://rubygems.org/gems/jekyll-octicons)
+[![Build Status](https://travis-ci.org/primer/octicons.svg?branch=master)](https://travis-ci.org/primer/octicons)
 
-See https://primer.style/octicons/packages/jekyll
+> A liquid jekyll tag that injects Octicon svg into the page
+
+This jekyll liquid tag, is a plugin that will let you easily include svg [octicons][octicons-docs] in your jekyll sites.
+
+## Install
+
+1. Add this to your `Gemfile`
+
+    ```rb
+    gem 'jekyll-octicons'
+    ```
+
+2. Add this to your jekyll `_config.yml`
+
+    ```yml
+    gems:
+      - jekyll-octicons
+    ```
+
+3. Use this tag in your jekyll templates
+
+    ```
+    {% octicon alert height:32 class:"right left" aria-label:hi %}
+    ```
+
+We recommend including the CSS in the [octicons_node](../octicons_node/) module. You can also npm install that package and include `build/build.css` in your styles.
+
+## Documentation
+
+For a full list of options available, see the [octicons_gem documentation](../octicons_gem/#documentation)
+
+## License
+
+(c) GitHub, Inc.
+
+When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).
+
+[MIT](./LICENSE)  
+
+[octicons]: https://github.com/primer/octicons
+[octicons-docs]: https://octicons.github.com/