update docs and readme

gateweaver · Apr 27, 2024 · a6d3f60 · a6d3f60
1 parent 9229957
commit a6d3f60
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
 # Gateweaver
 
-Gateweaver is an open-source API gateway designed for front-end applications, enabling secure integration with third party APIs that require sensitive keys and tokens. Through a simple YAML configuration file, users can define endpoints and apply essential policies like CORS, rate limiting, API key management, and JWT authentication, ensuring robust security measures are in place. Get started quickly with the CLI or Docker image, or take a look at some [examples](https://github.com/gateweaver/gateweaver/tree/main/examples) to see how you can leverage Gateweaver in your projects.
+Gateweaver is an open-source API gateway designed for front-end applications, enabling secure integration with third party APIs that require sensitive keys and tokens. Through a simple YAML configuration file, users can define endpoints and apply essential policies like CORS, rate limiting, API key management, and JWT authentication, ensuring robust security measures are in place.
+
+Get started quickly with the CLI or Docker image, or take a look at some [examples](https://github.com/gateweaver/gateweaver/tree/main/examples) to see how you can leverage Gateweaver in your projects.
 
 [Read the full documentation](https://gateweaver.io/docs/getting-started)
 

diff --git a/packages/cli/README.md b/packages/cli/README.md
@@ -1,6 +1,8 @@
 # Gateweaver
 
-Gateweaver is an open-source API gateway designed for front-end applications, enabling secure integration with third party APIs that require sensitive keys and tokens. Through a simple YAML configuration file, users can define endpoints and apply essential policies like CORS, rate limiting, API key management, and JWT authentication, ensuring robust security measures are in place. Get started quickly with the CLI or Docker image, or take a look at some [examples](https://github.com/gateweaver/gateweaver/tree/main/examples) to see how you can leverage Gateweaver in your projects.
+Gateweaver is an open-source API gateway designed for front-end applications, enabling secure integration with third party APIs that require sensitive keys and tokens. Through a simple YAML configuration file, users can define endpoints and apply essential policies like CORS, rate limiting, API key management, and JWT authentication, ensuring robust security measures are in place.
+
+Get started quickly with the CLI or Docker image, or take a look at some [examples](https://github.com/gateweaver/gateweaver/tree/main/examples) to see how you can leverage Gateweaver in your projects.
 
 [Read the full documentation](https://gateweaver.io/docs/getting-started)
 

diff --git a/packages/docs/docs/getting-started.md b/packages/docs/docs/getting-started.md
@@ -7,7 +7,9 @@ import TabItem from "@theme/TabItem";
 
 # Getting Started
 
-Gateweaver is an open-source API gateway designed for front-end applications, enabling secure integration with third party APIs that require sensitive keys and tokens. Through a simple YAML configuration file, users can define endpoints and apply essential policies like CORS, rate limiting, API key management, and JWT authentication, ensuring robust security measures are in place. Get started quickly with the CLI or Docker image, or take a look at some [examples](https://github.com/gateweaver/gateweaver/tree/main/examples) to see how you can leverage Gateweaver in your projects.
+Gateweaver is an open-source API gateway designed for front-end applications, enabling secure integration with third party APIs that require sensitive keys and tokens. Through a simple YAML configuration file, users can define endpoints and apply essential policies like CORS, rate limiting, API key management, and JWT authentication, ensuring robust security measures are in place.
+
+Get started quickly with the CLI or Docker image, or take a look at some [examples](https://github.com/gateweaver/gateweaver/tree/main/examples) to see how you can leverage Gateweaver in your projects.
 
 ## Installation
 

diff --git a/packages/docs/docusaurus.config.ts b/packages/docs/docusaurus.config.ts
@@ -4,7 +4,7 @@ import type * as Preset from "@docusaurus/preset-classic";
 
 const config: Config = {
  title: "Gateweaver",
- tagline: "An API Gateway for the frontend",
+ tagline: "A simple open-source API Gateway for frontend applications",
  favicon: "img/logo.png",
 
  // Set the production url of your site here
@@ -63,7 +63,7 @@ const config: Config = {
  position: "left",
  label: "Docs",
  },
- // { to: "blog", label: "Blog", position: "left" },
+ { to: "blog", label: "Blog", position: "left" },
  {
  href: "https://github.com/gateweaver/gateweaver",
  label: "GitHub",

diff --git a/packages/docs/src/pages/index.tsx b/packages/docs/src/pages/index.tsx
@@ -32,8 +32,8 @@ function HomepageHeader() {
 export default function Home(): JSX.Element {
  return (
  <Layout
- title="Gateweaver, An API Gateway for the frontend"
- description="An API Gateway for the frontend"
+ title="Gateweaver, A simple open-source API Gateway for frontend applications"
+ description="A simple open-source API Gateway for frontend applications"
  >
  <HomepageHeader />
  <main>

diff --git a/packages/server/README.md b/packages/server/README.md
@@ -1,9 +1,13 @@
 # Gateweaver
 
-Gateweaver is an open-source API gateway designed for front-end applications, enabling secure integration with third party APIs that require sensitive keys and tokens. Through a simple YAML configuration file, users can define endpoints and apply essential policies like CORS, rate limiting, API key management, and JWT authentication, ensuring robust security measures are in place. Get started quickly with the CLI or Docker image, or take a look at some [examples](https://github.com/gateweaver/gateweaver/tree/main/examples) to see how you can leverage Gateweaver in your projects.
+Gateweaver is an open-source API gateway designed for front-end applications, enabling secure integration with third party APIs that require sensitive keys and tokens. Through a simple YAML configuration file, users can define endpoints and apply essential policies like CORS, rate limiting, API key management, and JWT authentication, ensuring robust security measures are in place.
+
+Get started quickly with the CLI or Docker image, or take a look at some [examples](https://github.com/gateweaver/gateweaver/tree/main/examples) to see how you can leverage Gateweaver in your projects.
 
 [Read the full documentation](https://gateweaver.io/docs/getting-started)
 
+[Have a question or found a bug?](https://github.com/gateweaver/gateweaver/issues/new)
+
 ## Getting Started
 
 ### Installation