jekyll-octicons 0.0.0.pre.4de81bd → 0.0.0.pre.4e4ee6b

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb71f2f393f8af173ca2a6cb88eba33cb2930549a9ebee0153c5b3b8944ea69a
-  data.tar.gz: b1b5b01ca8551404a87ef3d17bf49b283ca255c5a9b3498a60649e633002fc5c
+  metadata.gz: fd62b6e380a61a7f484d2698432ad509f7f3f5e606de6a96e9b61bd2c77c82fc
+  data.tar.gz: e6c5c63e42ac9f4fea824cef1ec7d92ec83f937fd6a2e0bfe7f58330f5e0fa6b
 SHA512:
-  metadata.gz: 29872cdb8628465b9d48a7101b1effa36b09735f8e22fa9ba5d9cf823ff5f09f81659d324b471a14c1a7501e7032fb33098fe27b9381b725aca3222624bb157f
-  data.tar.gz: 2874e93006e131495fceef2dd2664a2769595941c5e500f7008d2d1dcb2eaf49885429f38f2e1bd8f1dbb86fe2dac40ce101f2b7c325d471d3a74019b5276a8a
+  metadata.gz: 922848b5e7a34381d5707a4f893a354f4d2a713a3ab162fdf6b35804f38025e2dedb4951b13cb371d0b5a65a8fecf68492e5681ab97638930b777a853c503fe9
+  data.tar.gz: 69e6c58034b77f40b01eb1597bd0aadc23c57d72ee2929ac40c60b90796d08fff02c738affdba93a921c3856d20c567b6e99c88c81ca23bc9ad3a694d6fa2ed6

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/