Rename surrealdb.js to surrealdb (#317)

surrealdb · Jul 23, 2024 · 49c5ee5 · 49c5ee5
1 parent e9d8f78
commit 49c5ee5
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 26 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -44,8 +44,8 @@ body:
   - type: input
     id: library-version
     attributes:
-      label: SurrealDB.js version
-      description: Enter your project's directory, then copy and paste the output of `npm view surrealdb.js version`
+      label: JavaScript SDK version
+      description: Enter your project's directory, then copy and paste the output of `npm view surrealdb version`
       placeholder: '0.0.0'
     validations:
       required: true

diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -8,7 +8,7 @@ body:
   - type: markdown
     attributes:
       value: |
-        Thanks for taking the time to suggest an idea for SurrealDB.js!
+        Thanks for taking the time to suggest an idea for the SurrealDB JavaScript SDK!
   - type: textarea
     id: problem
     attributes:
@@ -44,8 +44,8 @@ body:
   - type: input
     id: library-version
     attributes:
-      label: SurrealDB.js version
-      description: Enter your project's directory, then copy and paste the output of `npm view surrealdb.js version`
+      label: JavaScript SDK version
+      description: Enter your project's directory, then copy and paste the output of `npm view surrealdb version`
       placeholder: '0.0.0'
     validations:
       required: true

diff --git a/README.md b/README.md
@@ -15,11 +15,11 @@
     &nbsp;
     <a href="https://surrealdb.com/docs/integration/libraries/javascript"><img src="https://img.shields.io/badge/docs-view-44cc11.svg?style=flat-square"></a>
     &nbsp;
-    <a href="https://www.npmjs.com/package/surrealdb.js"><img src="https://img.shields.io/npm/v/surrealdb.js?style=flat-square"></a>
+    <a href="https://www.npmjs.com/package/surrealdb"><img src="https://img.shields.io/npm/v/surrealdb?style=flat-square"></a>
     &nbsp;
-    <a href="https://www.npmjs.com/package/surrealdb.js"><img src="https://img.shields.io/npm/dm/surrealdb.js?style=flat-square"></a>
+    <a href="https://www.npmjs.com/package/surrealdb"><img src="https://img.shields.io/npm/dm/surrealdb?style=flat-square"></a>
     &nbsp;
-    <a href="https://deno.land/x/surrealdb"><img src="https://img.shields.io/npm/v/surrealdb.js?style=flat-square&label=deno"></a>
+    <a href="https://deno.land/x/surrealdb"><img src="https://img.shields.io/npm/v/surrealdb?style=flat-square&label=deno"></a>
 </p>
 
 <p align="center">
@@ -32,7 +32,7 @@
     <a href="https://www.youtube.com/channel/UCjf2teVEuYVvvVC-gFZNq6w"><img src="https://img.shields.io/badge/youtube-subscribe-fc1c1c.svg?style=flat-square"></a>
 </p>
 
-# surrealdb.js
+# surrealdb
 
 The official SurrealDB SDK for JavaScript.
 
@@ -50,31 +50,29 @@ Import it with:
 import Surreal from "@surrealdb/surrealdb";
 ```
 
-For best results, set a version in the url:
-
-### Install for [Node.js](https://www.npmjs.com/package/surrealdb.js)
+### Install for [Node.js](https://www.npmjs.com/package/surrealdb)
 
 Install it with:
 
 ```sh
 # using npm
-npm i surrealdb.js
+npm i surrealdb
 # or using pnpm
-pnpm i surrealdb.js
+pnpm i surrealdb
 # or using yarn
-yarn add surrealdb.js
+yarn add surrealdb
 ```
 
 Next, just import it with:
 
 ```ts
-const { Surreal } = require("surrealdb.js");
+const { Surreal } = require("surrealdb");
 ```
 
 or when you use modules:
 
 ```ts
-import Surreal from "surrealdb.js";
+import Surreal from "surrealdb";
 ```
 
 ### Install for the browser
@@ -83,33 +81,33 @@ For usage in a browser environment, when using a bundler (e.g. [Rollup](https://
 
 ```sh
 # using npm
-npm i surrealdb.js
+npm i surrealdb
 # or using pnpm
-pnpm i surrealdb.js
+pnpm i surrealdb
 # or using yarn
-yarn add surrealdb.js
+yarn add surrealdb
 ```
 
 Next, just import it with:
 
 ```ts
-import Surreal from "surrealdb.js";
+import Surreal from "surrealdb";
 ```
 
 or when you use CommonJS:
 
 ```ts
-const { Surreal } = require("surrealdb.js");
+const { Surreal } = require("surrealdb");
 ```
 
 ### Install for the browser with a CDN
 
 For fast prototyping we provide a browser-ready bundle. You can import it with:
 
 ```ts
-import Surreal from "https://unpkg.com/surrealdb.js";
+import Surreal from "https://unpkg.com/surrealdb";
 // or
-import Surreal from "https://cdn.jsdelivr.net/npm/surrealdb.js";
+import Surreal from "https://cdn.jsdelivr.net/npm/surrealdb";
 ```
 
 _**NOTE: this bundle is not optimized for production! So don't use it in production!**_
@@ -123,7 +121,7 @@ In the example below you can see how to connect to a remote instance of SurrealD
 > This example makes use of [top level await](https://v8.dev/features/top-level-await), available in [modern browsers](https://caniuse.com/mdn-javascript_operators_await_top_level), [Deno](https://deno.com/) and [Node.js](https://nodejs.org/) >= 14.8.
 
 ```ts
-import { Surreal, RecordId, Table } from "surrealdb.js";
+import { Surreal, RecordId, Table } from "surrealdb";
 
 const db = new Surreal();
 

diff --git a/package.json b/package.json
@@ -1,5 +1,5 @@
 {
-	"name": "surrealdb.js",
+	"name": "surrealdb",
 	"version": "1.0.0-beta.18",
 	"type": "module",
 	"license": "Apache-2.0",