Skip to content

Commit

Permalink
Merge pull request FirefoxUX#38 from FirefoxUX/readme-fixes
Browse files Browse the repository at this point in the history
Readme fixes
  • Loading branch information
lmorchard committed Oct 23, 2018
2 parents a51d11a + 30734cf commit ea91fce
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,23 @@

[![CircleCI](https://circleci.com/gh/FirefoxUX/photon-components-web.svg?style=svg)](https://circleci.com/gh/FirefoxUX/photon-components-web)

Photon versions of the some common web UI components
This repository contains CSS styles and some React components to replicate the standard styles used in Firefox. The most recent style guidelines for Firefox are called "Photon" (hence the name of this repository).

These components are intended to be used anywhere where you want to make an HTML interface appear to be part of the browser itself. Examples where this might be useful include add-ons/extensions, UI directly in Firefox that is implemented in HTML, and some Mozilla properties like addons.mozilla.org.

This repository is not intended for a general audience. You do not have to use React to make use of the styles.

## Development

To get started:

```sh
npm install
# To generate static CSS and images/ in dist/ :
npm run build:webpack
# To run the demonstration site locally on http://localhost:9001/ :
npm start
```

## Conventions

Expand Down

0 comments on commit ea91fce

Please sign in to comment.