danog/amp

mirror of https://github.com/danog/amp.git synced 2024-11-26 20:15:00 +01:00

History

Niklas Keller 0192030eb3 Improve promise documentation This includes an extended introduction. It marks Deferred as advanced API and removes the note for the performance hack.		2017-12-21 16:40:10 +01:00
..
.shared@cb9279c84c	Update shared documentation files	2017-12-14 19:16:21 +01:00
cancellation	Improve cancellation documentation to reflect the latest features	2017-05-27 19:46:14 +02:00
coroutines	Fix typo	2017-06-04 11:45:26 +02:00
event-loop	Discourage onReadable / onWritable and recommend amphp/byte-stream instead	2017-11-11 11:45:02 +01:00
iterators	Fix page titles to allow a menu	2017-05-26 21:13:34 +02:00
promises	Improve promise documentation	2017-12-21 16:40:10 +01:00
utils	updated class spelling	2017-08-01 22:21:01 +02:00
_config.yml	Fix shared asset path for docs	2017-09-27 13:49:15 +02:00
.gitignore	Allow ./docs to be published as Jekyll page	2017-05-26 19:56:02 +02:00
asset	Update to new shared repository	2017-09-27 13:25:40 +02:00
Gemfile	Allow ./docs to be published as Jekyll page	2017-05-26 19:56:02 +02:00
Gemfile.lock	Allow ./docs to be published as Jekyll page	2017-05-26 19:56:02 +02:00
humans.txt	Add humans.txt to website	2017-05-28 16:07:07 +02:00
index.md	Improve introduction	2017-05-26 21:42:33 +02:00
README.md	Allow ./docs to be published as Jekyll page	2017-05-26 19:56:02 +02:00

README.md

Documentation

This directory contains the documentation for amphp/amp. Documentation and code are bundled within a single repository for easier maintenance. Additionally, this preserves the documentation for older versions.

Reading

You can read this documentation either directly on GitHub or on our website. While the website will always contain the latest version, viewing on GitHub also works with older versions.

Writing

Our documentation is built using Jekyll.

sudo gem install bundler jekyll

bundle install --path vendor/bundle
bundle exec jekyll serve