mirror of https://gitee.com/answerdev/answer.git
docs: reformat readme file
This commit is contained in:
parent
6303a1ba7e
commit
6bd8fce27f
|
@ -1,24 +1,29 @@
|
||||||
![logo](docs/img/logo.png)
|
|
||||||
|
|
||||||
# Answer - Simple Q&A Community
|
# Answer - Simple Q&A Community
|
||||||
|
|
||||||
|
![logo](docs/img/answer-logo-flat.svg)
|
||||||
|
|
||||||
[![LICENSE](https://img.shields.io/badge/License-MIT-green)](https://github.com/segmentfault/answer/blob/master/LICENSE)
|
[![LICENSE](https://img.shields.io/badge/License-MIT-green)](https://github.com/segmentfault/answer/blob/master/LICENSE)
|
||||||
[![Language](https://img.shields.io/badge/Language-Go-blue.svg)](https://golang.org/)
|
[![Language](https://img.shields.io/badge/Language-Go-blue.svg)](https://golang.org/)
|
||||||
[![Language](https://img.shields.io/badge/Language-React-blue.svg)](https://reactjs.org/)
|
[![Language](https://img.shields.io/badge/Language-React-blue.svg)](https://reactjs.org/)
|
||||||
|
|
||||||
## What is Answer?
|
## What is Answer?
|
||||||
|
|
||||||
This is a minimalist open source Q&A community. Users can post questions and others can answer them.
|
This is a minimalist open source Q&A community. Users can post questions and others can answer them.
|
||||||
![abstract](docs/img/abstract.png)
|
![abstract](docs/img/abstract.png)
|
||||||
|
|
||||||
## Why?
|
## Why?
|
||||||
|
|
||||||
- Help organizations build knowledge and Q&A communities better and faster.
|
- Help organizations build knowledge and Q&A communities better and faster.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Produce knowledge by asking and answering questions.
|
- Produce knowledge by asking and answering questions.
|
||||||
- Maintain knowledge by voting and working together.
|
- Maintain knowledge by voting and working together.
|
||||||
|
|
||||||
## Quick start
|
## Quick start
|
||||||
|
|
||||||
### Running with docker-compose
|
### Running with docker-compose
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
mkdir answer && cd answer
|
mkdir answer && cd answer
|
||||||
wget https://github.com/segmentfault/answer/releases/latest/download/docker-compose.yaml
|
wget https://github.com/segmentfault/answer/releases/latest/download/docker-compose.yaml
|
||||||
|
|
Loading…
Reference in New Issue