Skip to content

Commit

Permalink
update readme, satellite -> template
Browse files Browse the repository at this point in the history
  • Loading branch information
samanpwbb committed May 2, 2016
1 parent 2489249 commit 3955664
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 36 deletions.
38 changes: 4 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

This repository contains prebuilt Mapbox GL styles for use in Mapbox GL JS or the Mapbox Mobile SDKs and as a starting point for custom maps built with [Mapbox Studio](https://www.mapbox.com/mapbox-studio/).

If you're looking for Mapbox Streets, Mapbox Dark, Mapbox Light, or Mapbox Outdoors, see https://www.mapbox.com/maps//

## Versioning

Expand All @@ -23,7 +24,7 @@ A __feature__ release (0.__x__.0) has no breaking-release changes and

A __fix__ release (0.0.__x__) is one that has no feature-release changes and

- fixes an invalid stylesheet or bad test
- fixes an invalid stylesheet or bad test

## Styles

Expand All @@ -37,50 +38,19 @@ Simple and flexible starting template.

Template for complex custom basemaps.

#### Streets (`streets-v8`)

A complete basemap, perfect for incorporating your own data.

#### Light (`light-v8`)

Subtle light backdrop for data visualizations.

#### Dark (`dark-v8`)

Subtle dark backdrop for data visualizations.

#### Emerald (`emerald-v8`)

A versatile style, with emphasis on road networks and public transit.

#### Satellite (`satellite-v8`)

A beautiful global satellite and aerial imagery layer.

#### Satellite Streets (`satellite-hybrid-v8`)

Global satellite and aerial imagery with unobtrusive labels.

#### Empty (`empty-v8`)

A blank slate. Build your own map from the ground up.

## Standard icons

List of standard icons available in each style, except Emerald:

- [Maki](https://github.com/mapbox/mapbox-gl-styles/blob/master/index.js#L36-L106)
- [Highway shields](https://github.com/mapbox/mapbox-gl-styles/blob/master/index.js#L264-L397)
- [Rail network icons](https://github.com/mapbox/mapbox-gl-styles/blob/master/index.js#L108-L165)
- [Rail maki icons](https://github.com/mapbox/mapbox-gl-styles/blob/master/index.js#L399-L404)

List of Emerald's standard icons available:

- [Emerald's Maki](https://github.com/mapbox/mapbox-gl-styles/blob/master/index.js#L238-L262)
- [Emerald's Rail network icons](https://github.com/mapbox/mapbox-gl-styles/blob/master/index.js#L167-L220)
- [Emerald's Rail maki icons](https://github.com/mapbox/mapbox-gl-styles/blob/master/index.js#L406-L410)
All styles except Empty include [these sprite images](https://github.com/mapbox/maki/blob/master/layouts/streets.json) from the Maki project.

When you use an icon in a style, you must specify the icon's size as a suffix to its name. Supported size suffixes are `-11` and `-15`, representing an 11px and a 15px square respectively. For example, a 15px airfield icon would be specified as `"icon-image": "airfield-15"`.
When you use an icon in a style, you must specify the icons size as a suffix to its name. Supported size suffixes are `-11` and `-15`, representing an 11px and a 15px square respectively. For example, a 15px airfield icon would be specified as `"icon-image": "airfield-15"`.

## Usage

Expand Down
2 changes: 1 addition & 1 deletion styles/satellite-v9.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"name": "Satellite",
"metadata": {
"mapbox:autocomposite": true,
"mapbox:type": "template"
"mapbox:type": "default"
},
"sources": {
"mapbox": {
Expand Down
3 changes: 2 additions & 1 deletion test/test.js
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,8 @@ test('.sprite names', function(t) {
test('.metadata', function(t) {
Object.keys(mapboxGL.styles).forEach(function(s) {
if (s.indexOf('-v9') !== -1) {
t.equal(mapboxGL.styles[s].metadata['mapbox:type'], 'template', 'Type metadata for ' + mapboxGL.styles[s].name);
var metadataAssertion = mapboxGL.styles[s].name.indexOf('Satellite') !== -1 ? 'default' : 'template';
t.equal(mapboxGL.styles[s].metadata['mapbox:type'], metadataAssertion, 'Type metadata for ' + mapboxGL.styles[s].name);
t.equal(mapboxGL.styles[s].metadata['mapbox:autocomposite'], true, 'autocomposite metadata for ' + mapboxGL.styles[s].name);
}
});
Expand Down

0 comments on commit 3955664

Please sign in to comment.