@saplingai/sapling-js 1.0.33-beta.1 → 1.0.34

package/README.md

@@ -1,64 +1,51 @@
-# sapling-js
+# Sapling JS
 
 Node.js client for the [Sapling.ai API](https://sapling.ai/api).
 
 Try out a [grammar check demo](https://sapling.ai/grammar-check).
 Compare against grammar checking tools and APIs like Grammarly (Grammerly), LanguageTool, ProWritingAid and Ginger.
 
-Functionality
---------
+## Functionality
 
 Sapling is an AI messaging assistant.
 The API currently offers spelling and grammar checking endpoints.
 
 Benefits include:
-- **60% more grammar corrections**: compared to [other systems](https://sapling.ai/comparison/api) at similar accuracy using state-of-the-art machine learning systems for natural language processing.
+- **60% more grammar corrections**: Compared to [other systems](https://sapling.ai/comparison/api) at similar accuracy using state-of-the-art generative AI models.
 - **Low Latency**: Achieve the same real-time performance that users of Sapling's own interface experience.
 - **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.
+- **Custom Models**: Get corrections optimized for your content type, from academic writing, to medical notes, to user-generated reviews.
 - **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. Sapling's [HTML SDK](https://sapling.ai/docs/sdk/HTML/quickstart) can also be directly imported into HTML pages as JavaScript.
 
-
 ### Node.js
-sapling-js can be run in a Node.js server or script environment.
 
-See [this folder](https://github.com/saplingai/sapling-samples/tree/master/javascript/script) for an example of grammar checking without UI.
+Sapling can be run in a Node.js server or script environment.
 
+See [this folder](https://github.com/saplingai/sapling-samples/tree/master/javascript/script) for an example of grammar checking without UI.
 
 ### React
-sapling-js can be imported directly into a React project.
 
-See [this React App](https://github.com/saplingai/sapling-samples/tree/master/javascript/react-app) for a React demo app.
+Sapling can be imported directly into a React project.
 
+See [this React App](https://github.com/saplingai/sapling-samples/tree/master/javascript/react-app) for a React demo app.
 
 ### Angular
-sapling-js provides Angular support.
-
-See [this Angular App](https://github.com/saplingai/sapling-samples/tree/master/javascript/angular-app) for an Angular demo app.
-
-
-### Typescript
-sapling-js provides Typescript declarations and can be imported directly into a Typescript project.
 
-See [this Typescript App](https://github.com/saplingai/sapling-samples/tree/master/javascript/angular-app) for a Typescript demo app.
+For Angular support, refer to [this Angular App](https://github.com/saplingai/sapling-samples/tree/master/javascript/angular-app) for an Angular demo app.
 
---------
+### TypeScript
 
+For TypeScript declarations and how Sapling can be imported directly into a TypeScript project, see [this TypeScript App](https://github.com/saplingai/sapling-samples/tree/master/javascript/angular-app) for a demo app.
 
-Installation
---------
+## Installation
 
-`npm install @saplingai/sapling-js`
+- `npm install @saplingai/sapling-js`
+- Create a key by following [these instructions](https://sapling.ai/docs/api/api-access).
 
-- Register for an account at [Sapling.ai](https://sapling.ai/user/register).
-- After registering and signing in, generate a development API key in your [dashboard](https://sapling.ai/user_settings).
+## Backend Quickstart
 
-
-Quickstart - Backend
------------
-
-```javscript
+```javascript
 import { Client } from "@saplingai/sapling-js/client";
 
 const apiKey = '<YOUR_API_KEY>';
@@ -68,36 +55,37 @@ client
   .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
-//     }
-//   ]
-// }
 ```
 
+You should see something like the following output:
+
+```javascript
+{
+  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
+    }
+  ]
+}
+```
 
-Quickstart - Frontend
------------
+## Frontend Quickstart
 
 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/JavaScript/frontend_documentation#deploying-to-production) for an example of setting up the API key with a separate backend environment.
 
-```javscript
+```javascript
 import { useEffect } from 'react';
 import { Sapling } from "@saplingai/sapling-js/observer";
 
-
 function App() {
   useEffect(() => {
     Sapling.init({
@@ -120,11 +108,8 @@ function App() {
 }
 ```
 
+## Further Documentation
 
-Documentation
--------------
-
-- Complete Sapling HTTP API and SDK [documentation](https://sapling.ai/docs).
-- Get a production key by following [these instructions](https://sapling.ai/docs/api/api-access).
-- JavaScript, HTML, and Python [starter code](https://github.com/saplingai/sapling-samples).
-- More information on [request options and response structure](https://sapling.ai/docs/api/edits-overview).
+- Full Sapling HTTP API and SDK [documentation](https://sapling.ai/docs).
+- Create a key by following [these instructions](https://sapling.ai/docs/api/api-access).
+- JavaScript, HTML, and Python [starter code](https://github.com/saplingai/sapling-samples).

package/index.d.ts

@@ -1 +1 @@
-export * from '../sapling/client';
+export * from './sapling/client';

package/index.ts

@@ -1 +1 @@
-export * from '../sapling/client';
+export * from './sapling/client';

package/package.json

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