Skip to content

Commit d7fb94e

Browse files
authored
docs(readme): Improve README: add new logo, simplify (#714)
Also moves the GreenKeeper badge to the correct line
1 parent 3a92ab9 commit d7fb94e

File tree

2 files changed

+11
-38
lines changed

2 files changed

+11
-38
lines changed

.github/documentation-js-logo.png

33.1 KB
Loading

README.md

Lines changed: 11 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,23 @@
1-
# documentation
1+
<p align="center">
2+
<img src="./.github/documentation-js-logo.png" width="650" />
3+
</p>
24

3-
[![Greenkeeper badge](https://badges.greenkeeper.io/documentationjs/documentation.svg)](https://greenkeeper.io/)
5+
<p align="center">
6+
The documentation system for modern JavaScript
7+
</p>
48

9+
[![Greenkeeper badge](https://badges.greenkeeper.io/documentationjs/documentation.svg)](https://greenkeeper.io/)
510
[![Circle CI](https://circleci.com/gh/documentationjs/documentation/tree/master.svg?style=shield)](https://circleci.com/gh/documentationjs/documentation/tree/master)
611
[![npm version](https://badge.fury.io/js/documentation.svg)](http://badge.fury.io/js/documentation)
712
[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/documentationjs/documentation?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
813
[![David](https://david-dm.org/documentationjs/documentation.svg)](https://david-dm.org/documentationjs/documentation)
914
[![Coverage Status](https://coveralls.io/repos/github/documentationjs/documentation/badge.svg?branch=master)](https://coveralls.io/github/documentationjs/documentation?branch=master)
1015
[![Inline docs](http://inch-ci.org/github/documentationjs/documentation.svg?branch=master&style=flat-square)](http://inch-ci.org/github/documentationjs/documentation)
1116

12-
A **documentation generation system** that's
13-
_beautiful_ by default, _flexible_ across formats and styles, and
14-
_powerful_ enough to support [JSDoc](http://usejsdoc.org/)'s advanced syntax.
15-
16-
**ES5 and ES6 support of JavaScript, with support for other transpilers a possibility**
17-
18-
Using [babel](https://babeljs.io/), we have support for a wide range
19-
of [ES6 & ES7 features](https://github.com/lukehoban/es6features), as well
20-
as [Flow](http://flowtype.org/) type annotations.
21-
22-
**Powerful inference**
23-
24-
By statically analyzing your JavaScript code, documentation.js can write
25-
many parts of your documentation for you. It can infer parameter names
26-
and types, class membership, return values from Flow types, and lots more.
27-
28-
**Support for C++**
29-
30-
You can use the `--polyglot` mode of documentationjs to document native node.js
31-
modules in JSDoc _within the C++ code that implements the feature_.
32-
33-
**Support for following dependency trees**
34-
35-
Using [module-deps](https://github.com/substack/module-deps), `documentation` can
36-
crawl `require()` graphs - pointing it to your app's `main` file will find all
37-
referenced files and include all of their documentation.
38-
39-
**GitHub Integration**
40-
41-
The `--github` option automatically permalinks documentation to the exact
42-
sections of code it refers to in a GitHub repository.
43-
44-
**Gulp integration**
45-
46-
The [gulp-documentation](https://github.com/documentationjs/gulp-documentation) project
47-
lets you run `documentation` as a [Gulp](http://gulpjs.com/) build task.
17+
* Supports modern JavaScript: ES5, ES2017, JSX, and [Flow](http://flowtype.org/) type annotations.
18+
* Infers parameters, types, membership, and more. Write less documentation: let the computer write it for you.
19+
* Integrates with GitHub to link directly from documentation to the code it refers to.
20+
* Customizable output: HTML, JSON, Markdown, and more
4821

4922
## Examples
5023

0 commit comments

Comments
 (0)