@saplingai/sapling-js 1.0.7-beta.0 → 1.0.8

package/README.md

@@ -17,7 +17,7 @@ Benefits include:
 - **Over 20 error types**: Error categories such as preposition, noun form, and verb tense, including both high-level and fine-grained error information.
 - **Custom Models**: Get corrections and edits tuned to the domain of your text—for example academic writing vs. subtitles.
 - **Enterprise Security**: Contact us for our no data retention policies, [self-hosted/on-premises](https://sapling.ai/onprem) deployment options, and other [cybersecurity policies and procedures](https://sapling.ai/security).
-- **Rich Text Editor Support**: TinyMCE, CKEditor, QuillJS, Trix, ProseMirror, WordPress, Draft.js, Froala, Lexical and others. Consider using [Sapling's JavaScript SDK](https://sapling.ai/docs/sdk/JavaScript/quickstart) for displaying the API's outputs on webpage editors.
+- **Rich Text Editor Support**: TinyMCE, CKEditor, QuillJS, Trix, ProseMirror, WordPress, Draft.js, Froala, Lexical and others. Sapling's [HTML SDK](https://sapling.ai/docs/sdk/HTML/quickstart) can also be directly imported into HTML pages as JavaScript.
 
 
 ### Node.js
@@ -64,11 +64,25 @@ import { Client } from "@saplingai/sapling-js/client";
 const apiKey = '<YOUR_API_KEY>';
 const client = new Client(apiKey);
 client
-  .edits('Lets get started!')
+  .edits('I have a apple!')
   .then(function (response) {
     console.log(response.data);
   })
 
+// {
+//   edits: [
+//     {
+//       end: 8,
+//       error_type: 'R:DET:ART',
+//       general_error_type: 'Grammar',
+//       id: '740071c9-8ea3-583d-a86b-7ef80e5fc91e',
+//       replacement: 'an',
+//       sentence: 'I have a apple',
+//       sentence_start: 0,
+//       start: 7
+//     }
+//   ]
+// }
 ```
 
 
@@ -77,7 +91,7 @@ Quickstart - Frontend
 
 The SDK provides a way to automatically apply edit suggestions to any HTML contenteditable and textarea elements.
 
-Do **not** serve a page like this publicly, as it exposes the API key. See documentation [Deploying to Production](https://sapling.ai/docs/sdk/quickstart#deploying-to-production) for an example of setting up the API key with a separate backend environment.
+Do **not** serve a page like this publicly, as it exposes the API key. See documentation [Deploying to Production](https://sapling.ai/docs/sdk/JavaScript/frontend_documentation#deploying-to-production) for an example of setting up the API key with a separate backend environment.
 
 ```javscript
 import { useEffect } from 'react';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@saplingai/sapling-js",
-  "version": "1.0.7-beta.0",
+  "version": "1.0.8",
   "description": "JavaScript library for using the Sapling.ai API.",
   "type": "module",
   "dependencies": {

package/sapling/observer.js

@@ -1,3 +1,3 @@
-import { SaplingModule } from './sapling-sdk-v1.0.2.min.js';
+import { SaplingModule } from './sapling-sdk-v1.0.4.min.js';
 
 export const Sapling = SaplingModule.SaplingModule;