mirror of https://github.com/danog/byte-stream.git synced 2024-11-26 20:04:51 +01:00

History

Niklas Keller bd2de267cc Update shared documentation files This is an automated commit. Please report any issues to https://github.com/amphp/website-tools.		2018-05-16 16:15:55 +02:00
..
.shared@bd32eb0458	Update shared documentation files	2018-05-16 16:15:55 +02:00
_config.yml	Update docs nav	2018-03-13 10:32:38 -05:00
.gitignore	Turn ./docs into a Jekyll site	2017-05-28 19:24:13 +02:00
asset	Update to new shared docs repo	2017-09-27 13:56:06 +02:00
compression-streams.md	Fix typo	2017-06-12 23:04:28 +02:00
Gemfile	Turn ./docs into a Jekyll site	2017-05-28 19:24:13 +02:00
Gemfile.lock	Upgrade documentation dependencies	2018-02-07 13:52:39 +01:00
in-memory-stream.md	Turn ./docs into a Jekyll site	2017-05-28 19:24:13 +02:00
index.md	Update docs nav	2018-03-13 10:32:38 -05:00
iterator-stream.md	Turn ./docs into a Jekyll site	2017-05-28 19:24:13 +02:00
message.md	Add Payload docs	2018-03-13 10:26:29 -05:00
payload.md	Add Payload docs	2018-03-13 10:26:29 -05:00
README.md	Turn ./docs into a Jekyll site	2017-05-28 19:24:13 +02:00
resource-streams.md	Update shared docs and make resource streams available as document	2017-06-14 12:48:57 +02:00

README.md

Documentation

This directory contains the documentation for amphp/byte-stream. 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

git submodule init
git submodule update

cd docs

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