Merge pull request #144 from netglue/readme-update

Add some docs to the readme

README.md

@@ -12,12 +12,14 @@
 
 This library provides an API client so that you can read and write your document type definitions using the [Prismic Custom Types API](https://prismic.io/docs/technologies/custom-types-api).
 
-Currently, you can list, read, insert and update document types.
+Currently, you can list, read, insert and update document types, and do the same for 'Shared Slices'
 
-The client requires that you make use of _(And similarly, it returns instances of)_ the shipped `Definition` value object.
+The client requires that you make use of _(And similarly, it returns instances of)_ the shipped `Definition` or `SharedSlice` value objects.
 
 Typically, you wouldn't interact with the client directly, but as part of a build process that takes care of all that stuff for you. This client is quite fresh, but it's primary use will soon be part of [`netglue/prismic-cli`](https://github.com/netglue/prismic-cli), so that it will become trivial to synchronise your local development document definitions with those in your production Prismic repository _(and vice-versa)_.
 
+It's worth noting that document types and slices are not validated in any way. That's up to you, but, you should get descriptive exceptions when your JSON doesn't validate on the remote server.
+
 ## Installation
 
 The only supported installation method is via composer:
@@ -44,16 +46,64 @@ $client = new BaseClient(
 )
 ```
 
+## Usage
+
+### CRUD for Document Types
+
+```php
+use Prismic\DocumentType\Client;
+use Prismic\DocumentType\Definition;
+
+assert($client instanceof Client);
+
+// Insert or update a document type:
+$client->saveDefinition(Definition::new(
+    id: 'my-type',
+    label: 'Some Label',
+    repeatable: true,
+    active: true,
+    json: $someJsonPayloadAsAString,
+));
+
+// Fetch all remote document type defs
+$client->fetchAllDefinitions();
+
+// Fetch a single definition
+$client->getDefinition('some-type');
+
+// Delete a document type definition
+$client->deleteDefinition('some-type');
+```
+
+### CRUD for Shared Slices
+
+```php
+use Prismic\DocumentType\SharedSlice;use Prismic\DocumentType\SharedSliceManagementClient;
+
+assert($client instanceof SharedSliceManagementClient);
+
+// Insert or update a slice def:
+$client->saveSharedSlice(SharedSlice::new(
+    id: 'some-slice-id',
+    json: $someJsonPayloadAsAString, 
+));
+
+// Fetch all slice defs:
+$client->fetchAllSharedSlices();
+
+// Fetch one slice def:
+$client->getSharedSlice('whatever');
+
+// Delete a shared slice:
+$client->deleteSharedSlice('some-id');
+```
+
 ## Limitations/Roadmap
 
 ### Authentication
 
 Currently, authentication is only possible with a [permanent access token](https://prismic.io/docs/technologies/custom-types-api#permanent-token-recommended) that you create/retrieve from the Prismic repository settings. Session based tokens are not supported.  
 
-### Slices
-
-CRUD operations on shared slices are not yet implemented but are planned for future development. If you really want this feature, you're welcome to contribute.
-
 ## Contributing
 
 Please feel free to get involved with development. The project uses PHPUnit for tests, [Psalm](https://psalm.dev) for static analysis and [Infection](https://infection.github.io) for mutation testing. CI should have your back if you want to submit a feature or fix ;)