Skip to content

Commit 1e8b186

Browse files
authored
Added TOC and Provider section
1 parent 919ceea commit 1e8b186

1 file changed

Lines changed: 39 additions & 2 deletions

File tree

README.md

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,28 @@
11
# Mobility Data Specification
22

3+
## Table of Contents
4+
5+
- [About](#about)
6+
- [Endpoints](#endpoints)
7+
- [Get Involved](#get-involved)
8+
- [Versions](#versions)
9+
- [Cities Using MDS](#cities-using-mds)
10+
- [Providers Using MDS](#providers-using-mds)
11+
- [Use Cases](#use-cases)
12+
- [Related Projects](#related-projects)
13+
14+
## About
15+
316
The Mobility Data Specification (**MDS**), a project of the [Open Mobility Foundation](http://www.openmobilityfoundation.org) (OMF), is a set of Application Programming Interfaces (APIs) focused on dockless e-scooters, bicycles, mopeds and carshare. Inspired by projects like [GTFS](https://developers.google.com/transit/gtfs/reference/) and [GBFS](https://github.com/NABSA/gbfs), the goals of MDS are to provide a standardized way for municipalities or other regulatory agencies to ingest, compare and analyze data from mobility service providers, and to give municipalities the ability to express regulation in machine-readable formats.
417

518
**MDS** helps cities interact with companies who operate dockless scooters, bicycles, mopeds and carshare in the public right-of-way. MDS is a key piece of digital infrastructure that supports the effective implementation of mobility policies in cities around the world.
619

720
**MDS** is an open-source project. It was originally created by the [Los Angeles Department of Transportation](http://ladot.io) (LADOT). In November 2019, stewardship of MDS and the ownership of this repository was transferred to the Open Mobility Foundation. GitHub automatically redirects any links to this repository in the `CityOfLosAngeles` organization to the `openmobilityfoundation` instead. MDS continues to be used by LADOT and many other municipalities.
821

22+
[Top][toc]
23+
24+
## Endpoints
25+
926
**MDS** is currently comprised of three distinct components:
1027

1128
* The [`provider`][provider] API endpoints are intended to be implemented by mobility providers and consumed by regulatory agencies. When a municipality queries information from a mobility provider, the Provider API has a historical view of operations in a standard format. It was first released in June 2018. Development takes place under the guidance of the OMF's Provider Services Working Group.
@@ -16,11 +33,14 @@ The Mobility Data Specification (**MDS**), a project of the [Open Mobility Found
1633

1734
MDS is designed to be a modular kit-of-parts. Regulatory agencies can use the components of the API that are appropriate for their needs. An agency may choose to use only `agency`, `provider`, or `policy`. Or they may select specific elements (endpoints) from each to help them implement their goals.
1835

19-
Many parts of the MDS definitions and APIs align across each other. In these cases, consolidated information can be found on the [General Information](/general-information.md) page.
36+
Many parts of the MDS definitions and APIs align across each other. In these cases, consolidated information can be found on the [General Information](/general-information.md) page.
2037

2138
You can read more about the different APIs here: **[Understanding the different MDS APIs](https://github.com/openmobilityfoundation/mobility-data-specification/wiki/Understanding-MDS-APIs)**
2239

23-
## Learn More / Get Involved / Contributing
40+
[Top][toc]
41+
42+
## Get Involved
43+
2444
To stay up to date on MDS releases, meetings, and events, please **subscribe to the [mds-announce](https://groups.google.com/a/groups.openmobilityfoundation.org/forum/#!forum/mds-announce) mailing list.**
2545

2646
The Mobility Data Specification is an open source project with all development taking place on GitHub. Comments and ideas can be shared by [creating an issue](https://github.com/openmobilityfoundation/mobility-data-specification/issues), and specific changes can be suggested by [opening a pull request](https://github.com/openmobilityfoundation/mobility-data-specification/pulls). Before contributing, please review our OMF [CONTRIBUTING page](https://github.com/openmobilityfoundation/governance/blob/main/CONTRIBUTING.md) to understand guidelines and policies for participation and our [CODE OF CONDUCT page](https://github.com/openmobilityfoundation/governance/blob/main/CODE_OF_CONDUCT.md).
@@ -38,6 +58,8 @@ You can view info about past releases and planning calls in the [wiki](https://g
3858

3959
For questions about MDS please contact [info@openmobilityfoundation.org](mailto:info@openmobilityfoundation.org). Media inquiries to [media@openmobilityfoundation.org](mailto:media@openmobilityfoundation.org)
4060

61+
[Top][toc]
62+
4163
## Versions
4264

4365
The latest MDS release is in the [`main`](https://github.com/openmobilityfoundation/mobility-data-specification/tree/main) branch, and preparation for the next release occurs in the [`dev`](https://github.com/openmobilityfoundation/mobility-data-specification/tree/dev) branch.
@@ -50,6 +72,8 @@ The MDS specification is versioned using Git tags and [semantic versioning](http
5072
* [Release Timeline](https://github.com/openmobilityfoundation/mobility-data-specification/wiki#mds-releases)
5173
* [Release Guidelines](https://github.com/openmobilityfoundation/governance/blob/main/technical/ReleaseGuidelines.md)
5274

75+
[Top][toc]
76+
5377
## Cities Using MDS
5478

5579
More than 90 cities and public agencies around the world use MDS, and it has been implemented by most major mobility providers. Below are links to some of the specific agency programs/policies:
@@ -84,6 +108,14 @@ for Shareable Dockless Mobility Device Permit Holders](https://www.atlantaga.gov
84108

85109
Other cities include Baltimore, Bellevue, Charlotte, and Oakland, as mentioned in the [NACTO Guidelines for Regulating Shared Micromobility](https://nacto.org/wp-content/uploads/2019/09/NACTO_Shared_Micromobility_Guidelines_Web.pdf), page 48.
86110

111+
[Top][toc]
112+
113+
## Providers Using MDS
114+
115+
Over two dozen mobility service providers around the world use MDS, allowing them to create tools around a single data standard for multiple cities. For a full list, see the MDS [provider list](/providers.csv).
116+
117+
[Top][toc]
118+
87119
## Use Cases
88120
Some examples of how cities are using MDS in practice:
89121

@@ -101,6 +133,8 @@ Some examples of how cities are using MDS in practice:
101133

102134
More details and examples can be seen on our [Wiki](https://github.com/openmobilityfoundation/governance/wiki/MDS-Use-Cases).
103135

136+
[Top][toc]
137+
104138
## Related Projects
105139

106140
### Open Mobility Foundation
@@ -131,6 +165,9 @@ More details and examples can be seen on our [Wiki](https://github.com/openmobil
131165

132166
Please open a pull request if you create open source or private tools for implementing or working with MDS data.
133167

168+
[Top][toc]
169+
134170
[agency]: /agency/README.md
135171
[provider]: /provider/README.md
136172
[policy]: /policy/README.md
173+
[toc]: #table-of-contents

0 commit comments

Comments
 (0)