framework/extensions/lang-english/README.md

# English Language Pack for Flarum

## Installation

This language pack is bundled with [Flarum](http://flarum.org/download/).

## Translating Flarum

1. Fork this repository.
2. Edit the [flarum.json](flarum.json) file:
  - `name` A lowercase and hyphens only name (e.g. **french**, **drunk-pirates**).
  - `title` A short descriptive label for the extension list (e.g. **French**, **Drunk Pirates Arr**).
  - `locale` An [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code of your locale, or a short identifier of at least 3 characters to prevent conflicts (e.g. **fr**, **pirate**).
  - `description` Complete description, possible in the same language (e.g. **Française pour vous**, **Arrr matey hoist the sails**).
  - `author` Replace with your own information.
  - `icon` Change to suit your needs, play with the name for the FontAwesome icon, color for the icon color and background for the background color of the icon.
3. Modify the files under `/locale` to suit your needs. These hold all the actual translations.