Skip to content

Commit

Permalink
feat: README updates (#3974)
Browse files Browse the repository at this point in the history
  • Loading branch information
gqcn authored Nov 27, 2024
1 parent 455830b commit 81aed06
Showing 1 changed file with 6 additions and 54 deletions.
60 changes: 6 additions & 54 deletions README.MD
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# GoFrame

<div align=center>
<img src="https://goframe.org/img/logo_full.png" width="300"/>
Expand All @@ -20,73 +19,26 @@

</div>

`GoFrame` is a modular, powerful, high-performance and enterprise-class application development framework of Golang.
A powerful framework for faster, easier, and more efficient project development.

# Features

- modular, loosely coupled design
- rich components, out-of-the-box
- automatic codes generating for efficiency
- simple and easy to use, detailed documentation
- interface designed components, with high scalability
- fully supported tracing and error stack feature
- specially developed and powerful ORM component
- robust engineering design specifications
- convenient development CLI tool provide
- OpenTelemetry observability features support
- OpenAPIV3 documentation generating, automatically
- much, much more...ready to explore?

# Documentation

- GoFrame Official Site: [https://goframe.org](https://goframe.org)
- GoFrame Official Site(en): [https://goframe.org/en](https://goframe.org/en)
- GoFrame Mirror Site(中文): [https://goframe.org.cn](https://goframe.org.cn)
- GoFrame Mirror Site(github pages): [https://pages.goframe.org](https://pages.goframe.org)
- GoDoc API: [https://pkg.go.dev/github.com/gogf/gf/v2](https://pkg.go.dev/github.com/gogf/gf/v2)


# Installation

Enter your repo. directory and execute following command:

## primary module

```bash
go get -u -v github.com/gogf/gf/v2
```

## cli tool

```bash
go install github.com/gogf/gf/cmd/gf/v2@latest
```

# Limitation

```
golang version >= 1.20
```

# Contributors

💖 Thanks all the contributors making GoFrame awesome! [[Contributors](https://github.com/gogf/gf/graphs/contributors)] 💖
💖 [Thanks to all the contributors who made GoFrame possible](https://github.com/gogf/gf/graphs/contributors) 💖

<a href="https://github.com/gogf/gf/graphs/contributors">
<img src="https://goframe.org/img/contributors.svg" />
<img src="https://goframe.org/img/contributors.svg?ver=1" />
</a>

# License

`GoFrame` is licensed under the [MIT License](LICENSE), 100% free and open-source, forever.


# Donators

If you love `GoFrame`, why not [buy developer a cup of coffee](https://goframe.org/supportus/donate)?

# Sponsors

We appreciate any kind of sponsorship for `GoFrame` development. If you've got some interesting, please contact WeChat `389961817` / Email `john@goframe.org`.

# Thanks

<a href="https://www.jetbrains.com/?from=GoFrame"><img src="https://goframe.org/img/jetbrains.png" height="120" alt="JetBrains"/></a>
<a href="https://www.atlassian.com/?from=GoFrame"><img src="https://goframe.org/img/atlassian.jpg" height="120" alt="Atlassian"/></a>

0 comments on commit 81aed06

Please # to comment.