Docs fixed & Updated

akcybex · Dec 28, 2023 · a2d6821 · a2d6821
1 parent ae09f7c
commit a2d6821
Show file tree

Hide file tree

Showing 16 changed files with 41 additions and 41 deletions.
diff --git a/Readme.md b/Readme.md
@@ -4,34 +4,34 @@
 [![NPM Downloads](https://img.shields.io/npm/dm/@akcybex/jstr.svg)](https://www.npmjs.com/package/@akcybex/jstr)
 [![File Size](https://img.shields.io/github/size/akcybex/jstr/dist/jstr.es.js)](https://github.com/akcybex/jstr)
 
-> `@akcybex/jsr` is a JavaScript library inspired
+> `@akcybex/jstr` is a JavaScript library inspired
 > by [Laravel 'Strings'](https://laravel.com/docs/10.x/strings) offering a chainable API for
 > streamlined string manipulation and facilitating common string operations in javascript with enhanced expressiveness.
 
 ## Installation
 
 ### Using npm
 
-You can install `@akcybex/jsr` using npm:
+You can install `@akcybex/jstr` using npm:
 
 ```bash
-npm install @akcybex/jsr
+npm install @akcybex/jstr
 ```
 
 ### Using Yarn
 
 Alternatively, you can use Yarn to add the package:
 
 ```bash
-yarn add @akcybex/jsr
+yarn add @akcybex/jstr
 ```
 
 ## Usage in Node.js
 
-After installing, you can use `@akcybex/jsr` in your Node.js application:
+After installing, you can use `@akcybex/jstr` in your Node.js application:
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const result = JStr.of("hello").repeat(3).upper().toString();
 console.log(result); // Outputs: 'HELLOHELLOHELLO'
@@ -253,7 +253,7 @@ clarity and conciseness in your code.
 
 ## Contributing
 
-Contributions to `@akcybex/jsr` are welcome. Please refer to the contributing guidelines for more information.
+Contributions to `@akcybex/jstr` are welcome. Please refer to the contributing guidelines for more information.
 
 ## License
 

diff --git a/docs/After.md b/docs/After.md
@@ -3,7 +3,7 @@
 ### Example#1
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const result = JStr.after("Hello world", "Hello");
 console.log(result); // Outputs: 'world'
@@ -12,7 +12,7 @@ console.log(result); // Outputs: 'world'
 ### Example#2
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const result = JStr.of("This is my name").toString().trim().after("This is");
 

diff --git a/docs/AfterLast.md b/docs/AfterLast.md
@@ -3,7 +3,7 @@
 ### Example#1
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const result = JStr.of("\\App\\Http\\Controllers\\Controller")
   .afterLast("\\")
@@ -14,7 +14,7 @@ console.log(result); // Outputs: 'Controller'
 ### Example#2
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const result = JStr.afterLast("abc123abc456abc789", "abc");
 

diff --git a/docs/Before.md b/docs/Before.md
@@ -3,7 +3,7 @@
 ### Example#1
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const result = JStr.of("Hello world").before("world").toString();
 console.log(result); // Outputs: 'Hello'
@@ -12,7 +12,7 @@ console.log(result); // Outputs: 'Hello'
 ### Example#2
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const result = JStr.before("This is my name", "my name");
 

diff --git a/docs/BeforeLast.md b/docs/BeforeLast.md
@@ -3,7 +3,7 @@
 ### Example#1
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const result = JStr.of("\\App\\Http\\Controllers\\Controller")
   .beforeLast("\\")
@@ -14,7 +14,7 @@ console.log(result); // Outputs: '\\App\\Http\\Controllers'
 ### Example#2
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const result = JStr.beforeLast("abc123abc456abc789", "abc");
 console.log(result); // Outputs: 'abc123abc456'

diff --git a/docs/Between.md b/docs/Between.md
@@ -3,7 +3,7 @@
 ### Example#1
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const result = JStr.of("The big lion and many fox fights each other for food")
   .between("big", "fights")
@@ -15,7 +15,7 @@ console.log(result); // Outputs: 'lion and many fox'
 ### Example#2
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const result = JStr.between(
   "The big lion and many fox fights each other for food",

diff --git a/docs/BetweenFirst.md b/docs/BetweenFirst.md
@@ -3,7 +3,7 @@
 ### Example#1
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const result = JStr.of("[a]bc[d]").betweenFirst("[", "]").toString();
 console.log(result); // Outputs: 'a'
@@ -12,7 +12,7 @@ console.log(result); // Outputs: 'a'
 ### Example#2
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const result = JStr.betweenFirst("[a]bcd", "[", "");
 

diff --git a/docs/Camel.md b/docs/Camel.md
@@ -3,7 +3,7 @@
 ### Example#1
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const result = JStr.of("foo_bar").camel().toString();
 console.log(result); // Outputs: 'fooBar'
@@ -12,7 +12,7 @@ console.log(result); // Outputs: 'fooBar'
 ### Example#2
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const result = JStr.camel("foo bar");
 

diff --git a/docs/Capitalize.md b/docs/Capitalize.md
@@ -3,7 +3,7 @@
 ### Example#1
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const str = JStr.of("hello world").capitalize().toString();
 console.log(str); // Outputs: 'Hello World'
@@ -12,7 +12,7 @@ console.log(str); // Outputs: 'Hello World'
 ### Example#2
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const str = JStr.of("HeLLo").capitalize().toString();
 console.log(str); // Outputs: 'Hello'
@@ -21,7 +21,7 @@ console.log(str); // Outputs: 'Hello'
 ### Example#3
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const str = JStr.capitalize("hELLO world");
 console.log(str); // Outputs: 'Hello World'

diff --git a/docs/Contains.md b/docs/Contains.md
@@ -3,7 +3,7 @@
 ### Example#1
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const result = JStr.of("Hello world").contains("world");
 console.log(result); // Outputs: 'true'
@@ -12,7 +12,7 @@ console.log(result); // Outputs: 'true'
 ### Example#2
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const result = JStr.of("This is my name").contains("my name");
 console.log(result); // Outputs: 'true'
@@ -21,7 +21,7 @@ console.log(result); // Outputs: 'true'
 ### Example#3
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const result = JStr.of(
   "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop"

diff --git a/docs/Headline.md b/docs/Headline.md
@@ -3,7 +3,7 @@
 ### Example#1
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const str = JStr.of("hello world").headline().toString();
 console.log(str); // Outputs: 'Hello World'
@@ -12,7 +12,7 @@ console.log(str); // Outputs: 'Hello World'
 ### Example#2
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const str = JStr.of("HeLLo").headline().toString();
 console.log(str); // Outputs: 'He Llo'
@@ -21,7 +21,7 @@ console.log(str); // Outputs: 'He Llo'
 ### Example#3
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const str = JStr.headline("hELLOworld");
 console.log(str); // Outputs: 'H Elloworld'

diff --git a/docs/Lower.md b/docs/Lower.md
@@ -3,7 +3,7 @@
 ### Example#1
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const str = JStr.of("HELLO").lower().toString();
 console.log(str); // Outputs: 'hello'
@@ -12,7 +12,7 @@ console.log(str); // Outputs: 'hello'
 ### Example#2
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const str = JStr.lower("HELLO");
 console.log(str); // Outputs: 'hello'

diff --git a/docs/Repeat.md b/docs/Repeat.md
@@ -3,7 +3,7 @@
 ### Example#1
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const str = JStr.of("he").repeat(5).toString();
 console.log(str); // Outputs: 'hehehehehe'
@@ -12,7 +12,7 @@ console.log(str); // Outputs: 'hehehehehe'
 ### Example#2
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const str = JStr.repeat("a", 5);
 console.log(str); // Outputs: 'aaaaa'

diff --git a/docs/Studly.md b/docs/Studly.md
@@ -3,7 +3,7 @@
 ### Example#1
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const result = JStr.of("foo_bar").studly().toString();
 console.log(result); // Outputs: 'FooBar'
@@ -12,7 +12,7 @@ console.log(result); // Outputs: 'FooBar'
 ### Example#2
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const result = JStr.studly("foo bar");
 

diff --git a/docs/Ucfirst.md b/docs/Ucfirst.md
@@ -3,7 +3,7 @@
 ### Example#1
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const str = JStr.of("hello world").ucfirst().toString();
 console.log(str); // Outputs: 'Hello world'
@@ -12,7 +12,7 @@ console.log(str); // Outputs: 'Hello world'
 ### Example#2
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const str = JStr.of("hELLO world").ucfirst().toString();
 console.log(str); // Outputs: 'HELLO world'
@@ -21,7 +21,7 @@ console.log(str); // Outputs: 'HELLO world'
 ### Example#3
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const str = JStr.ucfirst("hELLO world");
 console.log(str); // Outputs: 'HELLO world'

diff --git a/docs/Upper.md b/docs/Upper.md
@@ -3,7 +3,7 @@
 ### Example#1
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const str = JStr.of("hello").upper().toString();
 console.log(str); // Outputs: 'HELLO'
@@ -12,7 +12,7 @@ console.log(str); // Outputs: 'HELLO'
 ### Example#2
 
 ```javascript
-import JStr from "@akcybex/jsr";
+import JStr from "@akcybex/jstr";
 
 const str = JStr.upper("hello").toString();
 console.log(str); // Outputs: 'HELLO'