amp/docs/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.

## Managing Concurrency

The weak link when managing concurrency is humans; we simply don't think asynchronously or in parallel. Instead, we're really good at doing one thing at a time and the world around us generally fits this model. So to effectively design for concurrent processing in our code we have a couple of options:

1. Get smarter (not feasible);
2. Abstract concurrent task execution to make it feel synchronous.

Amp provides an [event loop](./event-loop/README.md), [promises](./promises/README.md) and [asynchronous iterators](./iterators/README.md) as building blocks for (fully) asynchronous libraries and applications. [Coroutines](./coroutines/README.md) make asynchronous code feel as synchronous as synchronous code.

Start with the [Introduction to Event Loops](./event-loop/).
Add intro README for the docs directory 2017-03-13 13:23:35 +01:00			`# 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.

Remove already documented items from managing-concurrency.md Merged a small part into the initial docs/README.md, most parts were already documented elsewhere. Generator docs might be helpful for building the coroutines documentation. 2017-05-03 13:12:42 +02:00			`## Managing Concurrency`

			`The weak link when managing concurrency is humans; we simply don't think asynchronously or in parallel. Instead, we're really good at doing one thing at a time and the world around us generally fits this model. So to effectively design for concurrent processing in our code we have a couple of options:`

			`1. Get smarter (not feasible);`
			`2. Abstract concurrent task execution to make it feel synchronous.`

			`Amp provides an [event loop](./event-loop/README.md), [promises](./promises/README.md) and [asynchronous iterators](./iterators/README.md) as building blocks for (fully) asynchronous libraries and applications. [Coroutines](./coroutines/README.md) make asynchronous code feel as synchronous as synchronous code.`

Add documentation stubs 2017-03-18 08:39:41 +01:00			`Start with the [Introduction to Event Loops](./event-loop/).`