diff --git a/README.markdown b/README.markdown index 857e4b7e87..8e13babb07 100644 --- a/README.markdown +++ b/README.markdown @@ -1,14 +1,26 @@ +

+
Tengine +

-Introduction [![Build Status](https://github.com/alibaba/tengine/actions/workflows/ci.yml/badge.svg)](https://github.com/alibaba/tengine/actions/workflows/ci.yml) -============ +

Visit tengine.taobao.org for the full documentation, +examples and guides.

+
+ +[![GitHub license](https://img.shields.io/github/license/alibaba/tengine.svg)](https://github.com/alibaba/tengine/blob/main/LICENSE) +[![GitHub stars](https://img.shields.io/github/stars/alibaba/tengine.svg)](https://github.com/alibaba/tengine/stargazers) +[![GitHub stars](https://img.shields.io/badge/contributions-welcome-orange.svg)](https://github.com/alibaba/tengine/blob/main/CONTRIBUTING.md) +[![Build Status](https://github.com/alibaba/tengine/actions/workflows/ci.yml/badge.svg)](https://github.com/alibaba/tengine/actions/workflows/ci.yml) + +
+ + +## Introduction Tengine is a web server originated by [Taobao](http://en.wikipedia.org/wiki/Taobao), the largest e-commerce website in Asia. It is based on the [Nginx](http://nginx.org) HTTP server and has many advanced features. Tengine has proven to be very stable and efficient on some of the top 100 websites in the world, including [taobao.com](http://www.taobao.com) and [tmall.com](http://www.tmall.com). Tengine has been an open source project since December 2011. It is being actively developed by the Tengine team, whose core members are from Taobao, Sogou and other Internet companies. Tengine is a community effort and everyone is encouraged to [get involved](https://github.com/alibaba/tengine). -Features -======== - +## Features * All features of nginx-1.24.0 are inherited, i.e., it is 100% compatible with nginx. * Dynamically reconfigure the servers, locations and upstreams without reloading or restarting worker processes with [tengine-ingress](https://github.com/alibaba/tengine-ingress). * HTTP/3 support (QUIC v1 and draft-29) with [xquic](https://github.com/alibaba/xquic). @@ -35,29 +47,32 @@ Features * Expiration times can be specified for certain MIME types. * ... -Installation -============ - +## Installation Tengine can be downloaded at [http://tengine.taobao.org/download/tengine.tar.gz](http://tengine.taobao.org/download/tengine.tar.gz). You can also checkout the latest source code from GitHub at [https://github.com/alibaba/tengine](https://github.com/alibaba/tengine) To install Tengine, just follow these three steps: - +```bash $ ./configure $ make # make install +``` By default, it will be installed to _/usr/local/nginx_. You can use the __'--prefix'__ option to specify the root directory. If you want to know all the _'configure'_ options, you should run __'./configure --help'__ for help. -Documentation -============= - +## Documentation The homepage of Tengine is at [http://tengine.taobao.org/](http://tengine.taobao.org/) You can access [http://tengine.taobao.org/documentation.html](http://tengine.taobao.org/documentation.html) for more information. -Contact -============= - +## Contact [https://github.com/alibaba/tengine/issues](https://github.com/alibaba/tengine/issues) Dingtalk user group: 23394285 + +## License + +[BSD-2-Clause License](https://github.com/alibaba/tengine/blob/master/LICENSE) + +

+ Tengine +

diff --git a/docs/image/tengine-logo.png b/docs/image/tengine-logo.png new file mode 100644 index 0000000000..7dde49425a Binary files /dev/null and b/docs/image/tengine-logo.png differ