Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions .github/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@ The fox is an extension of the [gin](https://github.com/gin-gonic/gin) framework

Fox is currently in beta and under active development. While it offers exciting new features, please note that it may not be stable for production use. If you choose to use, be prepared for potential bugs and breaking changes. Always check the official documentation and release notes for updates and proceed with caution. Happy coding!


## Installation

Fox requires **Go version `1.21` or higher** to run. If you need to install or upgrade Go, visit the [official Go download page](https://go.dev/dl/). To start setting up your project. Create a new directory for your project and navigate into it. Then, initialize your project with Go modules by executing the following command in your terminal:
Fox requires **Go version `1.23` or higher** to run. If you need to install or upgrade Go, visit the [official Go download page](https://go.dev/dl/). To start setting up your project. Create a new directory for your project and navigate into it. Then, initialize your project with Go modules by executing the following command in your terminal:

```bash
go mod init github.com/your/repo
Expand All @@ -25,7 +24,6 @@ go get -u github.com/fox-gonic/fox

This command fetches the Fox package and adds it to your project's dependencies, allowing you to start building your web applications with Fox.


## Quickstart

### Running fox Engine
Expand All @@ -50,7 +48,7 @@ func main() {

And use the Go command to run the demo:

```
```shell
# run example.go and visit 0.0.0.0:8080/ping on browser
$ go run example.go
```
Expand Down Expand Up @@ -152,4 +150,4 @@ $ curl -X POST http://localhost:8080/users/signup \
-H 'content-type: application/json' \
-d '{"username": "George", "email": "george@vandaley.com"}'
{"code":"PASSWORD_TOO_SHORT"}
```
```
10 changes: 10 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
version: 2
updates:
- package-ecosystem: github-actions
directory: /
schedule:
interval: weekly
- package-ecosystem: gomod
directory: /
schedule:
interval: weekly