Skip to content
This repository has been archived by the owner on Nov 18, 2021. It is now read-only.

Commit

Permalink
Add general usage to readme
Browse files Browse the repository at this point in the history
Links to instructions on how to include Origami components. Financial-Times/origami#59
  • Loading branch information
notlee committed Aug 7, 2020
1 parent 6368aa4 commit ab94fe9
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
Social media buttons.

- [Overview](#overview)
- [Usage](#usage)
- [Markup](#markup)
- [Sass](#sass)
- [JavaScript](#javascript)
Expand All @@ -15,6 +16,10 @@ Social media buttons.
* Provides the ability to share a URL provided by the product
* Uses a standard set of social media icons.

## Usage

Check out [how to include Origami components in your project](https://origami.ft.com/docs/components/#including-origami-components-in-your-project) to get started with `o-share`.

## Markup

The following markup is the simplest but requires JavaScript to work and does not support custom share icons or icon labels. If your project requires either of those features see the [full markup](#full-markup) section.
Expand Down

0 comments on commit ab94fe9

Please sign in to comment.