Merge pull request #123 from ozeanjs/update-docs

Update docs

Author: mrthiti

README.md

@@ -1,11 +1,18 @@
 <p align="center">
   <a href="https://ozeanjs.com">
-    <img src="./docs/src/assets/logo.svg" alt="OzeanJs" width="150">
+    <img src="./docs/docs/public/logo.svg" alt="OzeanJs" width="150">
   </a>
 </p>
 
 <p align="center">A progressive <a href="https://ozeanjs.com">OzeanJs</a> framework for crafting efficient and scalable server-side applications.</p>
 
+<p align="center">
+  <img src="https://img.shields.io/npm/v/ozean" alt="npm version">
+  <img src="https://img.shields.io/npm/dm/ozean" alt="npm download">
+  <img src="https://img.shields.io/badge/bun-compatible-brightgreen" alt="bun compatible">
+  <img src="https://img.shields.io/github/license/ozeanjs/ozean" alt="License">
+</p>
+
 # OzeanJs 🌊
 
 Welcome to [**OzeanJs**](https://ozeanjs.com)!
@@ -103,3 +110,11 @@ Hello cat.
 That's it! In just 3 simple steps, your first OceanJs project is ready to go. Try opening the project in your favorite editor and start modifying the code in the `src` folder!
 
 Happy coding with OzeanJs!
+
+[npm-url]: https://www.npmjs.com/package/ozean
+[npm-version-image]: https://img.shields.io/npm/v/ozean.svg?style=flat
+[npm-downloads-image]: https://img.shields.io/npm/dm/ozean.svg?style=flat
+[npm-downloads-url]: https://npmcharts.com/compare/ozean?minimal=true
+[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?style=flat
+[license-url]: LICENSE
+[bun-compatible]: https://img.shields.io/badge/bun-compatible-brightgreen

docs/docs/.vitepress/config.ts

@@ -107,6 +107,7 @@ export default defineConfig({
       { icon: 'github', link: 'https://github.com/ozeanjs/ozean' },
       { icon: 'npm', link: 'https://www.npmjs.com/package/ozean' },
       { icon: 'discord', link: 'https://discord.gg/rMBc8Snft4' },
+      { icon: 'x', link: 'https://x.com/ozeanjs' },
     ],
 
     search: {

docs/docs/cli/cli-new.md

@@ -20,8 +20,6 @@ ozean n <project-name>
 
 - **`<project-name>`** (required): The name of the folder and the project you want to create.
 
----
-
 ## What the `new` command does
 
 When you run `ozean new my-awesome-app`, the CLI automatically performs new project.

docs/docs/intro/core-concepts.md

@@ -8,8 +8,6 @@ The main components of an OceanJs application consist of three key parts:
 - **Providers**: Classes that handle Business Logic (mostly Services).
 - **Controllers**: Classes that receive HTTP Requests and send back Responses.
 
----
-
 ## 1. Modules: The Foundation of an Application
 
 Modules are the core of code organization in OceanJs. Every application has at least one module, the Root Module (e.g., `AppModule`). We use the `@Module()` decorator to define a module.
@@ -34,8 +32,6 @@ import { UsersService } from './users.service';
 export class UsersModule {}
 ```
 
----
-
 ## 2. Providers and Dependency Injection (DI)
 
 Providers are classes designed to "provide" various logic and can be "injected" (passed) into other parts of the application, such as Services, Repositories, Factories, or Helpers. We use the `@Injectable()` decorator to mark a class as a Provider.
@@ -68,8 +64,6 @@ export class UsersController {
 }
 ```
 
----
-
 ## 3. Controllers and Request Lifecycle
 
 Controllers are responsible for receiving incoming HTTP requests, processing them, and returning a response. We use Decorators to define routes and extract data from the request.

docs/docs/intro/quickstart.md

@@ -6,8 +6,6 @@ This guide shows the fastest way to create and run your first OzeanJs project us
 
 Ensure you have **Bun** installed on your machine.
 
----
-
 ### Step 1: Create a New Project with the CLI
 
 You don't need to install our CLI beforehand. You can use the `bunx` command to download and run it immediately.
@@ -29,8 +27,6 @@ Once the command is finished, navigate into your project folder:
 cd my-awesome-app
 ```
 
----
-
 ### Step 2: Run the Development Server
 
 Run your application in development mode with the command:
@@ -43,8 +39,6 @@ bun run index
 
 You should see a message in your terminal indicating that your application is running on `http://localhost:3000`.
 
----
-
 ### Step 3: Test the Application
 
 Open another terminal and use `curl` to test if the server is working correctly:

docs/docs/overview/first-steps.md

@@ -6,8 +6,6 @@ This document will guide you through installing and starting an OceanJs project.
 
 Ensure you have **Bun** installed on your machine.
 
----
-
 ## Method 1: Installation via Ozean CLI (Recommended)
 
 This is the **fastest and easiest** way to start your OceanJs project, as the CLI handles all the necessary basic setup automatically.
@@ -37,8 +35,6 @@ bun run index
 
 Your application will start running at `http://localhost:3000` immediately!
 
----
-
 ## Method 2: Manual Installation
 
 This method is suitable for those who want to control every aspect of the setup themselves from the beginning.

docs/docs/overview/pipes.md

@@ -15,8 +15,6 @@ We use the `@UsePipes()` decorator to "attach" the desired Pipe to the Route Han
 
 OzeanJs comes with a built-in `ValidationPipe`, a powerful pipe that works with the `class-validator` and `class-transformer` libraries to automatically validate and transform data from the request body according to a specified DTO (Data Transfer Object).
 
----
-
 ## Usage Example: Input Validation
 
 Here is a complete example of using `ValidationPipe` to validate data for creating a new user.

docs/docs/overview/providers.md

@@ -10,8 +10,6 @@ The `@Injectable()` decorator marks a class as a provider that can be managed by
 
 Dependency Injection is a design pattern where the framework takes control of creating and delivering dependencies (like services) to classes that need them (like controllers). In OzeanJs, this is done through constructor injection: you simply declare the dependency you need as a constructor parameter, along with its type. The framework handles the rest.
 
----
-
 ## Complete Example: `Users` Feature
 
 Here is a complete example that demonstrates how Controllers, Providers, and Modules work together.