From 51e1997f87b512df1b5a367524b152ed4ec37dc8 Mon Sep 17 00:00:00 2001 From: Brandon Shelley Date: Mon, 17 Oct 2016 13:29:53 -0700 Subject: [PATCH] Update README with better usage details and icons index --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0b0e4c8..7bec822 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,15 @@ Use of these icon fonts is intended for use with internal Apigee build systems, and is not intended for public consumption, distribution, or sale. You may not sub-license, re-sell, rent, lend, assign, gift or otherwise transfer or distribute the icons or the rights granted under this license (even for free). +###Icons Index + +You can preview available icons from here: https://apigee-internal.github.io/apigee-icons-build/ +_Note:_ This is a preview of the latest commit and may not accurately reflect previous versions of this icons repo. + +###Icon requests + +Please open an issue in this repo and use the `:new-icon-request:` tag. + ###Usage Include source font files and CSS in your project, then add an `@font-face` declaration to your CSS, similar to the following: @@ -20,6 +29,12 @@ Include source font files and CSS in your project, then add an `@font-face` decl } ``` +Then select an icon from the icons index page, and include the appropriate markup where you need to use the icon: + +``` + +``` + ###Support This is an open-source project of the Apigee Corporation. It is not covered by Apigee support contracts. However, we will support you as best we can. For help, please open an issue in this GitHub project. You are also always welcome to submit a pull request. @@ -38,4 +53,4 @@ Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and -limitations under the License. \ No newline at end of file +limitations under the License.