mirror of https://github.com/danog/byte-stream.git synced 2024-12-02 09:17:50 +01:00

History

Aaron Piotrowski 7a8d6d5f1f Remove Parser Moved to a separate repository at amphp/parser.		2017-06-07 22:23:44 -05:00
..
.shared@3cd8f565aa	Update shared, convert blockquote into note	2017-05-29 21:52:28 +02:00
_config.yml	Turn ./docs into a Jekyll site	2017-05-28 19:24:13 +02:00
.gitignore	Turn ./docs into a Jekyll site	2017-05-28 19:24:13 +02:00
compression-streams.md	Turn ./docs into a Jekyll site	2017-05-28 19:24:13 +02:00
Gemfile	Turn ./docs into a Jekyll site	2017-05-28 19:24:13 +02:00
Gemfile.lock	Turn ./docs into a Jekyll site	2017-05-28 19:24:13 +02:00
in-memory-stream.md	Turn ./docs into a Jekyll site	2017-05-28 19:24:13 +02:00
index.md	Remove Parser	2017-06-07 22:23:44 -05:00
iterator-stream.md	Turn ./docs into a Jekyll site	2017-05-28 19:24:13 +02:00
message.md	Turn ./docs into a Jekyll site	2017-05-28 19:24:13 +02:00
README.md	Turn ./docs into a Jekyll site	2017-05-28 19:24:13 +02:00
resource-streams.md	Respect chunk size for ResourceOutputStream, document resource streams	2017-05-25 18:12:12 +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