diff --git a/README.md b/README.md index 5f52c802..4b890954 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,10 @@ - ____ _ _ _ - | _ \| | (_) | | - | |_) | |_ _ ___ _ __ _ __ _ _ __ | |_ - | _ <| | | | |/ _ \ '_ \| '__| | '_ \| __| - | |_) | | |_| | __/ |_) | | | | | | | |_ - |____/|_|\__,_|\___| .__/|_| |_|_| |_|\__| - | | - |_| +![logo](./public/logo.png) -### 🚀 Introducing the Ultimate Golang Blueprint Library 🚀 +
+

+ Introducing the Ultimate Golang Blueprint Library +

+
Go Blueprint is a CLI tool that allows users to spin up a Go project with the corresponding structure seamlessly. It also gives the option to integrate with one of the more popular Go frameworks (and the list is growing with new features)! @@ -20,15 +17,23 @@ gives the option to integrate with one of the more popular Go frameworks (and th - Integrate with a popular frameworks - Focus on the actual code of your application -### Install +## Table of Contents -- **Brew install :** +- [Install](#install) +- [Frameworks Supported](#frameworks-supported) +- [Database Support](#database-support) +- [Usage Example](#usage-example) +- [GitHub Stats](#github-stats) +- [License](#license) -```sh -brew install Melkeydev/melkey/go-blueprint -``` + -- **Go install :** +

+ + + + Install +

```sh go install github.com/melkeydev/go-blueprint@latest @@ -50,10 +55,14 @@ go-blueprint create --name my-project --framework gin See `go-blueprint create -h` for all the options and shorthands. -![Starter Image](./public/blueprint_1.png) -![Framework Image](./public/blueprint_2.png) + -### Frameworks Supported +

+ + + + Frameworks Supported +

- [Chi](https://github.com/go-chi/chi) - [Gin](https://github.com/gin-gonic/gin) @@ -62,7 +71,14 @@ See `go-blueprint create -h` for all the options and shorthands. - [Gorilla/mux](https://github.com/gorilla/mux) - [Echo](https://github.com/labstack/echo) -## Database Support + + +

+ + + + Database Support +

Go Blueprint now offers enhanced database support, allowing you to choose your preferred database driver during project setup. Use the `--driver` or `-d` flag to specify the database driver you want to integrate into your project. @@ -75,7 +91,14 @@ Choose from a variety of supported database drivers: - [Sqlite](https://github.com/mattn/go-sqlite3) - [Mongo](go.mongodb.org/mongo-driver) -### Usage Example + + +

+ + + + Usage Example +

Here's an example of setting up a project with a specific database driver: @@ -83,6 +106,30 @@ Here's an example of setting up a project with a specific database driver: go-blueprint create --name my-project --framework gin --driver postgres ``` -### License +

+ Starter Image +

+ + + +

+ + + + Github Stats +

+ +

+ Alt +

+ + + +

+ + + + Licence +

Licensed under [MIT License](./LICENSE) diff --git a/public/blueprint_1.png b/public/blueprint_1.png index e432624d..e7391c70 100644 Binary files a/public/blueprint_1.png and b/public/blueprint_1.png differ diff --git a/public/blueprint_2.png b/public/blueprint_2.png deleted file mode 100644 index bed8260d..00000000 Binary files a/public/blueprint_2.png and /dev/null differ diff --git a/public/database.gif b/public/database.gif new file mode 100644 index 00000000..a3f9a194 Binary files /dev/null and b/public/database.gif differ diff --git a/public/example.gif b/public/example.gif new file mode 100644 index 00000000..911ba001 Binary files /dev/null and b/public/example.gif differ diff --git a/public/frameworks.gif b/public/frameworks.gif new file mode 100644 index 00000000..67001386 Binary files /dev/null and b/public/frameworks.gif differ diff --git a/public/install.gif b/public/install.gif new file mode 100644 index 00000000..cfb3f0ae Binary files /dev/null and b/public/install.gif differ diff --git a/public/license.gif b/public/license.gif new file mode 100644 index 00000000..222d2db8 Binary files /dev/null and b/public/license.gif differ diff --git a/public/logo.png b/public/logo.png new file mode 100644 index 00000000..9bf81b4f Binary files /dev/null and b/public/logo.png differ diff --git a/public/stats.gif b/public/stats.gif new file mode 100644 index 00000000..d0abacff Binary files /dev/null and b/public/stats.gif differ