diff --git a/README.md b/README.md index c1fd151..e1ce834 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,10 @@ [](https://www.buildingsmart.org/) [](https://img.shields.io/badge/-BCF%20Implementers%20Group-blue.svg) -[Swagger / OpenAPI Specification](./swagger.yaml). To view an interactive version of the Swagger specification, you can go to [Swagger Hub](https://app.swaggerhub.com/apis/buildingSMART/Documents-API/1.0). -# Documents API +[Swagger / OpenAPI Specification](./swagger.yaml). To view an interactive version of the Swagger specification, you can go to [Swagger Hub](https://app.swaggerhub.com/apis/buildingSMART/Documents-API/1.0). -<img src="./Images/CDE_Logo.png" width="200" height="200"> + The Documents API is designed to streamline the process of downloading and uploading files to a common data environment (CDE). This specification details the _selection_ or _discovery_, _download_ and _upload_ of files. When supported by both client and server, it provides an easy to use and integrated way of syncing cloud stored documents from within local applications. For the purpose of this specification, _a document_ consists of a file and its metadata. The scope of the Documents API includes all file types; the scope is not limited to building information models.