Skip to content

Commit

Permalink
Tidy README.md files (Fixes #121)
Browse files Browse the repository at this point in the history
  • Loading branch information
alexgibson committed May 25, 2018
1 parent 518eee1 commit eaa2f6c
Show file tree
Hide file tree
Showing 2 changed files with 151 additions and 169 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,29 @@ A modular design system for Mozilla websites.

https://mozilla-protocol.netlify.com/

## Quick Start
## Getting Started

Protocol is built on the [Node.js](https://nodejs.org/) platform and published to [NPM](https://www.npmjs.com/), so be sure to have both installed before proceeding.

## Installation

To use Protocol in your website you can install the core package directly from NPM:

```
npm install @mozilla-protocol/core --save
```

Alternatively, you can also [download the latest release](https://github.com/mozilla/protocol/releases/latest) from GitHub.
Alternatively, you can also [download the latest release]( https://github.com/mozilla/protocol/releases/latest) from GitHub.

## Usage

Once installed, the relevant CSS and JS files will be available in your project under `./mode_modules/@mozilla-protocol/core/`
Once installed, the relevant CSS and JS files will be available in your project under `./node_modules/@mozilla-protocol/core/`.

The core CSS is bundled as `protocol.css`. This contains styling for things such as basic elements and typography. Component and layout CSS is bundled as `protocol-extra.scss` for convenience.
The core CSS file is bundled as `protocol.css`, which contains styling for things such as basic elements and typography. Component and layout CSS is bundled as `protocol-extra.scss` for convenience.

**Note**: The original source (scss) files are also included in the published package. You may want to consider compiling your own CSS to include only what you need for each page of your website, in order to further optimize for performance.
**Note**: The original source (.scss) files are also included in the published package. You may want to consider compiling your own CSS to include only what you need for each page of your website, in order to further optimize for performance.

### Building from source
## Building From Source

To build Protocol from source including the documentatiion site, you can clone the repo from GitHub:

Expand All @@ -32,13 +36,13 @@ $ cd protocol
$ npm start
```

For a more info, read the [installation docs](docs#installation).
Running `npm start` will install dependencies, build your toolkit, and start the development server at <http://localhost:3000>.

## Documentation
## Further Documentation

- [Getting Started](docs#getting-started)
- [Project Structure](docs#project-structure)
- [Gulp Tasks](docs#tasks)
- [Build Process](docs#build-process)
- [Publishing](docs#publishing)
- [Acknowledgements](docs#acknowledgements)


Loading

0 comments on commit eaa2f6c

Please sign in to comment.