Skip to content

Commit

Permalink
Merge pull request #1819 from lianglli/master
Browse files Browse the repository at this point in the history
Readme: add star count and logo
  • Loading branch information
lianglli committed Jul 20, 2023
2 parents b59e2cc + d201217 commit a7081f5
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 15 deletions.
45 changes: 30 additions & 15 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,14 +1,26 @@
<h1 align="center" style="border-bottom: none">
<br>Tengine
</h1>

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

<div align="center">

[![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)

</div>


## 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).
Expand All @@ -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)

<h1 align="center" style="border-bottom: none">
<a href="https://tengine.taobao.org" target="_blank"><img alt="Tengine" src="/docs/image/tengine-logo.png"></a>
</h1>
Binary file added docs/image/tengine-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit a7081f5

Please sign in to comment.