Skip to content

Commit a7081f5

Browse files
authored
Merge pull request #1819 from lianglli/master
Readme: add star count and logo
2 parents b59e2cc + d201217 commit a7081f5

2 files changed

Lines changed: 30 additions & 15 deletions

File tree

README.markdown

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,26 @@
1+
<h1 align="center" style="border-bottom: none">
2+
<br>Tengine
3+
</h1>
14

2-
Introduction [![Build Status](https://github.com/alibaba/tengine/actions/workflows/ci.yml/badge.svg)](https://github.com/alibaba/tengine/actions/workflows/ci.yml)
3-
============
5+
<p align="center">Visit <a href="https://tengine.taobao.org" target="_blank">tengine.taobao.org</a> for the full documentation,
6+
examples and guides.</p>
47

8+
<div align="center">
9+
10+
[![GitHub license](https://img.shields.io/github/license/alibaba/tengine.svg)](https://github.com/alibaba/tengine/blob/main/LICENSE)
11+
[![GitHub stars](https://img.shields.io/github/stars/alibaba/tengine.svg)](https://github.com/alibaba/tengine/stargazers)
12+
[![GitHub stars](https://img.shields.io/badge/contributions-welcome-orange.svg)](https://github.com/alibaba/tengine/blob/main/CONTRIBUTING.md)
13+
[![Build Status](https://github.com/alibaba/tengine/actions/workflows/ci.yml/badge.svg)](https://github.com/alibaba/tengine/actions/workflows/ci.yml)
14+
15+
</div>
16+
17+
18+
## Introduction
519
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).
620

721
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).
822

9-
Features
10-
========
11-
23+
## Features
1224
* All features of nginx-1.24.0 are inherited, i.e., it is 100% compatible with nginx.
1325
* Dynamically reconfigure the servers, locations and upstreams without reloading or restarting worker processes with [tengine-ingress](https://github.com/alibaba/tengine-ingress).
1426
* HTTP/3 support (QUIC v1 and draft-29) with [xquic](https://github.com/alibaba/xquic).
@@ -35,29 +47,32 @@ Features
3547
* Expiration times can be specified for certain MIME types.
3648
* ...
3749

38-
Installation
39-
============
40-
50+
## Installation
4151
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)
4252

4353
To install Tengine, just follow these three steps:
44-
54+
```bash
4555
$ ./configure
4656
$ make
4757
# make install
58+
```
4859

4960
By default, it will be installed to _/usr/local/nginx_. You can use the __'--prefix'__ option to specify the root directory.
5061
If you want to know all the _'configure'_ options, you should run __'./configure --help'__ for help.
5162

52-
Documentation
53-
=============
54-
63+
## Documentation
5564
The homepage of Tengine is at [http://tengine.taobao.org/](http://tengine.taobao.org/)
5665
You can access [http://tengine.taobao.org/documentation.html](http://tengine.taobao.org/documentation.html) for more information.
5766

58-
Contact
59-
=============
60-
67+
## Contact
6168
[https://github.com/alibaba/tengine/issues](https://github.com/alibaba/tengine/issues)
6269

6370
Dingtalk user group: 23394285
71+
72+
## License
73+
74+
[BSD-2-Clause License](https://github.com/alibaba/tengine/blob/master/LICENSE)
75+
76+
<h1 align="center" style="border-bottom: none">
77+
<a href="https://tengine.taobao.org" target="_blank"><img alt="Tengine" src="/docs/image/tengine-logo.png"></a>
78+
</h1>

docs/image/tengine-logo.png

109 KB
Loading

0 commit comments

Comments
 (0)