Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ These modules are not necessarily meant to be deployed on the same device or wri

## API

The API of each module is specified via [Readium Evolution Proposals](https://readium.org/architecture/proposals/), which are discussed collaborativelty before being implemented by the core developers of the toolkits.
The API of each module is specified in the [Readium Specifications](specs), which are discussed collaboratively before being implemented by the core developers of the toolkits.

## Ecosystem

Expand Down
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions proposals/005-streamer-api.md → specs/005-streamer-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ While Readium ships with sane default parser settings, some degree of configurat
The Streamer is one of the main components of the Readium Architecture, whose responsibilities are to:

* parse packaged or exploded publications into a Readium `Publication` model
* [compose the `Fetcher` tree](https://github.com/readium/architecture/blob/master/proposals/002-composite-fetcher-api.md#developer-guide) providing access to publication resources
* [compose the `Fetcher` tree](https://github.com/readium/architecture/blob/master/specs/002-composite-fetcher-api.md#developer-guide) providing access to publication resources
* unlock content protection technologies

### Usage
Expand Down Expand Up @@ -144,7 +144,7 @@ If you just want to add HTTP headers or set up caching and networking policies f

The Readium Architecture is opened to support additional publication formats.

1. [Register your new format and add a sniffer](https://readium.org/architecture/proposals/001-media-type.html#supporting-a-custom-media-type). This step is optional but recommended to make your format a first-class citizen in the toolkit.
1. [Register your new format and add a sniffer](https://readium.org/architecture/specs/001-media-type.html#supporting-a-custom-media-type). This step is optional but recommended to make your format a first-class citizen in the toolkit.
2. Implement a `PublicationParser` to parse the publication format into a `Publication` object. Then, provide an instance to the Streamer.

```swift
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Summary

Introduction of a new [publication service](https://readium.org/architecture/proposals/004-publication-helpers-services.html) providing a way to search an excerpt through the content of a publication.
Introduction of a new [publication service](https://readium.org/architecture/specs/004-publication-helpers-services.html) providing a way to search an excerpt through the content of a publication.


## Motivation
Expand Down
File renamed without changes.
File renamed without changes.
10 changes: 5 additions & 5 deletions proposals/README.md → specs/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# REP - Readium Evolution Proposals
# Readium Specifications

Many changes, such as bug fixes, internal refactorings and documentation improvements, can be implemented and reviewed via the usual GitHub tools: issues and pull requests.
This directory contains the reference specifications for the public APIs of the Readium toolkit.

However, we ask that any change impacting the public API be put through a bit of design process and produce a consensus among the Readium community.
These specifications are living documents: changes to them, including changes impacting the public API, are discussed and made directly against these documents through the usual GitHub tools — issues and pull requests — until they reach consensus among the Readium community.

The REP (Readium Evolution Proposals) process is intended to provide a public space for discussing new features entering the Readium toolkit, so that all stakeholders can be confident about the direction the toolkit is following. It also serves as an archive and reference for existing (or soon to be) features.
This directory used to be `proposals/`, under the Readium Evolution Proposals (REP) process: new features were written up as standalone proposal documents, discussed, and approved before being merged as a historical record. That process is retired. It has been renamed to `specs/` — the documents below still read like proposals (with Motivation, Rationale, Drawbacks sections, etc.) rather than plain reference docs; that has not been rewritten.

## Approved Proposals
## Specifications

### [001 - Media Type](001-media-type.md)

Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes