@datocms/cma-client 0.1.0 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,24 +1,19 @@
1
- # `@datocms/cma-client`
1
+ [![Node.js CI](https://github.com/datocms/js-rest-api-clients/actions/workflows/node.js.yml/badge.svg)](https://github.com/datocms/js-rest-api-clients/actions/workflows/node.js.yml)
2
2
 
3
- > TODO: description
3
+ # DatoCMS Content Management JS API Client (Common)
4
4
 
5
- ## Usage (NodeJS)
5
+ API client for [DatoCMS](https://www.datocms.com). Take a look at the full [API documentation](https://www.datocms.com/docs/content-management-api) for examples.
6
6
 
7
- ```js
8
- const { buildClient } = require('@datocms/cma-client');
7
+ <br /><br />
8
+ <a href="https://www.datocms.com/">
9
+ <img src="https://www.datocms.com/images/full_logo.svg" height="60">
10
+ </a>
11
+ <br /><br />
9
12
 
10
- const client = buildClient({ apiToken: 'XXX' });
11
- const items = await client.items.list();
12
- ```
13
+ ## Contributing
13
14
 
14
- ## Usage (browser module)
15
+ Bug reports and pull requests are welcome on GitHub at https://github.com/datocms/js-rest-api-clients. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
15
16
 
16
- ```html
17
- <script type="module">
18
- // also valid: https://cdn.jsdelivr.net/npm/@datocms/cma-client/dist/browser/index.js
19
- import { buildClient } from 'https://unpkg.com/@datocms/cma-client/dist/browser/index.js';
17
+ ## License
20
18
 
21
- const client = buildClient({ apiToken: 'XXX' });
22
- const items = await client.items.list();
23
- </script>
24
- ```
19
+ The package is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).