diff --git a/README.md b/README.md index 652ef00..dff94c6 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ -# adidas API Guidelines -**DRAFT** | [**Read online at GitBook**](https://adidas-group.gitbooks.io/api-guidelines/content/) +![layers](/assets/adidas-group-logo.svg) -This document represents the guidelines for all APIs created the within adidas group. +# adidas API Guidelines +_The guidelines for API design at adidas._ + +([**Read online at GitBook**](https://adidas-group.gitbooks.io/api-guidelines/content/)) ## Motivation -The ultimate goal of these guidelines is to facilitate the work and minimize the effort of all API users while protecting their investment, thus encouraging API adoption. +The goal of this document is to facilitate the work and minimize the effort of all API users while protecting their investment and encouraging API adoption. -The guidelines should lay down the foundation for collaboration, achieving stability without rigidity while maintaining extensibility for the future. +The guidelines lay down the foundation for collaboration, stability and extensibility. ## Guidelines The API Guidelines are split into several levels: diff --git a/assets/adidas-group-logo.svg b/assets/adidas-group-logo.svg new file mode 100644 index 0000000..3772a4b --- /dev/null +++ b/assets/adidas-group-logo.svg @@ -0,0 +1,21 @@ + + + + Slice + Created with Sketch. + + + + + + + + + + + + + + + + \ No newline at end of file