@dotcms/client 0.0.1-alpha.52 → 0.0.1-alpha.53

package/README.md

@@ -1,16 +1,16 @@
-# DotCMS API Client - `@dotcms/client`
+# dotCMS API Client - `@dotcms/client`
 
-The `@dotcms/client` is a JavaScript/TypeScript library for interacting with a DotCMS instance. It allows you to easily fetch pages, content, and navigation information in JSON format, as well as to make complex queries on content collections.
+The `@dotcms/client` is a JavaScript/TypeScript library for interacting with a dotCMS instance. It allows you to easily fetch pages, content, and navigation information in JSON format, as well as to make complex queries on content collections.
 
 This client library provides a streamlined, promise-based interface to fetch pages and navigation API.
 
 ## Features
 
--   Easy-to-use methods to interact with the [DotCMS Page](https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas) and [Navigation APIs](https://www.dotcms.com/docs/latest/navigation-rest-api).
--   Support for custom actions to communicate with the DotCMS page editor.
+-   Easy-to-use methods to interact with [dotCMS pages](https://www.dotcms.com/docs/latest/page-rest-api-layout-as-a-service-laas) and the [Navigation API](https://www.dotcms.com/docs/latest/navigation-rest-api).
+-   Support for custom actions to communicate with the dotCMS page editor.
 -   Comprehensive TypeScript typings for better development experience.
 
-# DotCMS API Client
+# dotCMS API Client
 
 ## Installation
 
@@ -42,7 +42,9 @@ import { DotCmsClient } from '@dotcms/client';
 const { DotCmsClient } = require('@dotcms/client');
 ```
 
-First, initialize the client with your DotCMS instance details.
+### Initialization
+
+First, initialize the client with your dotCMS instance details.
 
 ```javascript
 const client = DotCmsClient.init({
@@ -54,7 +56,7 @@ const client = DotCmsClient.init({
 
 ### Fetching a Page
 
-You can retrieve the elements of any page in your DotCMS system in JSON format using the client.page.get() method.
+You can retrieve the elements of any page in your dotCMS system in JSON format using the `client.page.get()` method.
 
 ```javascript
 const pageData = await client.page.get({
@@ -66,7 +68,7 @@ const pageData = await client.page.get({
 
 ### Fetching Navigation
 
-Retrieve the DotCMS file and folder tree to get information about the navigation structure.
+Retrieve the dotCMS file and folder tree to get information about the navigation structure.
 
 ```javascript
 const navData = await client.nav.get({
@@ -78,7 +80,7 @@ const navData = await client.nav.get({
 
 ### Fetching a Collection of Content
 
-The `getCollection` method allows you to fetch a collection of content items using a builder pattern for complex queries.
+The `getCollection` method allows you to fetch a collection of content items (sometimes called "contentlets") using a builder pattern for complex queries.
 
 #### Basic Usage
 
@@ -125,7 +127,7 @@ const languageFilteredResponse = await client.content
 
 #### Using Complex Queries
 
-You can build more complex queries using the query builder. For example, filter by author and `title`:
+You can build more complex queries using the query builder. For example, filter by `author` and `title`:
 
 ```typescript
 const complexQueryResponse = await client.content
@@ -206,26 +208,27 @@ Detailed documentation of the `@dotcms/client` methods, parameters, and types ca
 
 ### `DotCmsClient.init(config: ClientConfig): DotCmsClient`
 
-Initializes the DotCMS client with the specified configuration.
+Initializes the dotCMS client with the specified configuration.
 
 ### `DotCmsClient.page.get(options: PageApiOptions): Promise<unknown>`
 
-Retrieves the specified page's elements from your DotCMS system in JSON format.
+Retrieves the specified page's elements from your dotCMS system in JSON format.
 
 ### `DotCmsClient.nav.get(options: NavApiOptions): Promise<unknown>`
 
-Retrieves information about the DotCMS file and folder tree.
+Retrieves information about the dotCMS file and folder tree.
 
 ### `DotCmsClient.content.getCollection(contentType: string): CollectionBuilder<T>`
-Creates a builder to filter and fetch a collection of content items for a specific content type.
+
+Creates a builder to filter and fetches a collection of content items for a specific content type.
 
 #### Parameters
 
-contentType (string): The content type to retrieve.
+`contentType` (string): The content type to retrieve.
 
 #### Returns
 
-CollectionBuilder<T>: A builder instance for chaining filters and executing the query.
+`CollectionBuilder<T>`: A builder instance for chaining filters and executing the query.
 
 ## Contributing
 
@@ -241,7 +244,7 @@ If you need help or have any questions, please [open an issue](https://github.co
 
 ## Documentation
 
-Always refer to the official [DotCMS documentation](https://www.dotcms.com/docs/latest/) for comprehensive guides and API references.
+Always refer to the official [dotCMS documentation](https://www.dotcms.com/docs/latest/) for comprehensive guides and API references.
 
 ## Getting Help
 
@@ -252,4 +255,4 @@ Always refer to the official [DotCMS documentation](https://www.dotcms.com/docs/
 | Videos          | [Helpful Videos](http://dotcms.com/videos/)                         |
 | Forums/Listserv | [via Google Groups](https://groups.google.com/forum/#!forum/dotCMS) |
 | Twitter         | @dotCMS                                                             |
-| Main Site       | [dotCMS.com](https://dotcms.com/)                                   |
+| Main Site       | [dotCMS.com](https://dotcms.com/)                                   |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dotcms/client",
-  "version": "0.0.1-alpha.52",
+  "version": "0.0.1-alpha.53",
   "description": "Official JavaScript library for interacting with DotCMS REST APIs.",
   "repository": {
     "type": "git",