Update README

README.md

@@ -4,9 +4,12 @@ An easy-to-use collection of all data from [X-Wing: The Miniatures Game (Second
 
 If you're looking for data and images of X-Wing First Edition, you can find that here: [xwing-data](https://github.com/guidokessels/xwing-data).
 
-### XWS2 ids
+## XWS ids
+
+Every ship, pilot, upgrade, etc. has a `xws` field that contains an unique id. These ids are used in the [X-Wing Squadron Specification (or `XWS`)](https://github.com/elistevens/xws-spec/).
+
+New XWS ids are generated using the following steps:
 
-XWS ids are generated using the following steps:
 1. Take the English-language name as printed on the card
 2. Lowercase the name
 3. Convert non-ASCII characters to closest ASCII equivalent (to remove umlauts, etc.)
@@ -19,3 +22,50 @@ Upgrades: `upgradename-slotname-productsku`
 Conditions: `conditionname-productsku`
 
 XWS ids have to be unique per type (pilot/upgrade/condition/etc) and do not collide with ids of other types. So there can be a `hansolo` _pilot_ and a `hansolo` _upgrade_, but there cannot be two upgrades with the `hansolo` xws id (regardless of the slot of those upgrades). One of those cards would get the `-slotname` suffix (for example: `hansolo-gunner`).
+
+## Scripts
+
+There are a few scripts that make it easier to work on the data.
+
+You can run these scripts using `npm` or `yarn`. For example:
+
+- `npm run hyperspace`
+- `yarn run hyperspace`
+
+### Scripts to update data
+
+| Script                | Description                                                                                                         |
+| --------------------- | ------------------------------------------------------------------------------------------------------------------- |
+| `yarn run hyperspace` | Syncs the `hyperspace` status of all cards with the FFG squadbuilder                                                |
+| `yarn run ffgscrape`  | Syncs all data with the FFG squadbuilder (and alerts on missing cards)                                              |
+| `yarn run ffg2xws`    | Generates the [`data/ffg-xws.json`](https://github.com/guidokessels/xwing-data2/blob/master/data/ffg-xws.json) file |
+
+### Scripts to work with the repository
+
+| Script                          | Description                                                                                                                                                 |
+| ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `yarn run format`               | Format all `.json` files in the `data` folder using [Prettier](https://prettier.io/)                                                                        |
+| `yarn run changelog A...B`      | Generate a changelog between commits `A` and `B`, to be used in the release description on GitHub.<br />Example usage: `yarn run changelog 1.24.0...1.25.0` |
+| `yarn run validate:json`        | Validate that all `.json` files contain valid JSON                                                                                                          |
+| `yarn run validate:tests`       | Run all unit tests                                                                                                                                          |
+| `yarn run validate:tests:watch` | Run all unit tests in watch mode                                                                                                                            |
+
+## Versioning
+
+This project uses [SemVer](http://semver.org/). Given a `MAJOR.MINOR.PATCH` version number, we will increment the:
+
+- `MAJOR` version when existing content is changed in such a way that it can break consumers of the data
+- `MINOR` version when new content is added in a backwards-compatible manner, or existing content is changed in a backwards-compatible manner
+- `PATCH` version when fixing mistakes in existing content
+
+## History
+
+See the [Releases tab](https://github.com/guidokessels/xwing-data2/releases) in Github.
+
+## License
+
+[MIT](http://guidokessels.mit-license.org/)
+
+---
+
+Star Wars, X-Wing: The Miniatures Game and all related properties, images and text are owned by Fantasy Flight Games, Lucasfilm Ltd., and/or Disney.