Skip to content
This repository has been archived by the owner on Aug 12, 2022. It is now read-only.

Commit

Permalink
Update README with better usage details and icons index
Browse files Browse the repository at this point in the history
  • Loading branch information
Brandon Shelley authored Oct 17, 2016
1 parent a971cfe commit 51e1997
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:

```
<i class="apic-icon apic-name"></i>
```

###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.
Expand All @@ -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.
limitations under the License.

0 comments on commit 51e1997

Please sign in to comment.