chore: update docs

Handfish · Feb 4, 2024 · e1bef90 · e1bef90
1 parent c14e4e2
commit e1bef90
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 <p align="center"><a href="https://github.com/Handfish/ajel" target="_blank"><img src="https://raw.githubusercontent.com/Handfish/ajel/main/apps/docs/public/ajel2.svg" width="100"></a></p>
 
-<p align="center">`ajel` and `sjel` are thin wrappers for try-catch, coupled with eslint rules to encourage better error handling.</p>
+<p align="center">ajel is a set of thin wrappers for try-catch, coupled with eslint rules to encourage better error handling.</p>
 
 <p align="center">
 <a href="https://www.npmjs.com/ajel" target="_blank"><img src="https://img.shields.io/npm/v/ajel.svg" alt="NPM Version" /></a>
@@ -27,7 +27,7 @@ import { ajel } from 'ajel';
 async function main() {
   const result = await ajel(Promise.resolve('hello world'));
 
-	// Accessing result before narrowing union type throws eslint error
+  // Accessing result before narrowing union type throws eslint error
   // console.log(result);
 
   if (result instanceof Error) {
@@ -46,7 +46,7 @@ import { sjel } from 'ajel';
 async function main() {
   const result = await sjel(JSON.parse, "{}");
 
-	// Accessing result before narrowing union type throws eslint error
+  // Accessing result before narrowing union type throws eslint error
   // console.log(result);
 
   if (result instanceof Error) {

diff --git a/apps/docs/src/pages/index.mdx b/apps/docs/src/pages/index.mdx
@@ -2,7 +2,7 @@
 
 ## What is ajel?
 
-Ajel is a **312 byte** set of functions that encourage you to handle errors in a way that is similar to Golang.
+ajel is a set of thin wrappers for try-catch, coupled with eslint rules to encourage better error handling.
 
 ### Installation
 

diff --git a/packages/ajel-core/readme.md b/packages/ajel-core/readme.md
@@ -1,6 +1,6 @@
 <p align="center"><a href="https://github.com/Handfish/ajel" target="_blank"><img src="https://raw.githubusercontent.com/Handfish/ajel/main/apps/docs/public/ajel2.svg" width="100"></a></p>
 
-<p align="center">`ajel` and `sjel` are thin wrappers for try-catch, coupled with eslint rules to encourage better error handling.</p>
+<p align="center">ajel is a set of thin wrappers for try-catch, coupled with eslint rules to encourage better error handling.</p>
 
 <p align="center">
 <a href="https://www.npmjs.com/ajel" target="_blank"><img src="https://img.shields.io/npm/v/ajel.svg" alt="NPM Version" /></a>
@@ -29,7 +29,7 @@ import { ajel } from 'ajel';
 async function main() {
   const result = await ajel(Promise.resolve('hello world'));
 
-	// Accessing result before narrowing union type throws eslint error
+  // Accessing result before narrowing union type throws eslint error
   // console.log(result);
 
   if (result instanceof Error) {
@@ -48,7 +48,7 @@ import { sjel } from 'ajel';
 async function main() {
   const result = await sjel(JSON.parse, "{}");
 
-	// Accessing result before narrowing union type throws eslint error
+  // Accessing result before narrowing union type throws eslint error
   // console.log(result);
 
   if (result instanceof Error) {

diff --git a/packages/eslint-plugin-ajel/README.md b/packages/eslint-plugin-ajel/README.md
@@ -1,6 +1,6 @@
 <p align="center"><a href="https://github.com/Handfish/ajel" target="_blank"><img src="https://raw.githubusercontent.com/Handfish/ajel/main/apps/docs/public/ajel2.svg" width="100"></a></p>
 
-<p align="center">`ajel` and `sjel` are thin wrappers for try-catch, coupled with eslint rules to encourage better error handling.</p>
+<p align="center">ajel is a set of thin wrappers for try-catch, coupled with eslint rules to encourage better error handling.</p>
 
 <p align="center">
 <a href="https://www.npmjs.com/ajel" target="_blank"><img src="https://img.shields.io/npm/v/ajel.svg" alt="NPM Version" /></a>