Skip to content

Commit

Permalink
EDRLab to Readium Foundation migration, see #18
Browse files Browse the repository at this point in the history
  • Loading branch information
danielweck committed Aug 30, 2018
1 parent 2ee3b39 commit cc4dc02
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion LICENSE
@@ -1,6 +1,6 @@
BSD 3-Clause License

Copyright (c) 2017, EDRLab
Copyright (c) 2018, Readium Foundation
All rights reserved.

Redistribution and use in source and binary forms, with or without
Expand Down
24 changes: 12 additions & 12 deletions README.md
Expand Up @@ -6,7 +6,7 @@ NodeJS implementation (written in TypeScript) and HTTP micro-services (Express m

## Build status

[![NPM](https://img.shields.io/npm/v/r2-streamer-js.svg)](https://www.npmjs.com/package/r2-streamer-js) [![David](https://david-dm.org/edrlab/r2-streamer-js/status.svg)](https://david-dm.org/edrlab/r2-streamer-js) [![Travis](https://travis-ci.org/edrlab/r2-streamer-js.svg?branch=develop)](https://travis-ci.org/edrlab/r2-streamer-js) [![Heroku](https://img.shields.io/badge/app-Heroku-blue.svg)](https://readium2.herokuapp.com) [![Now.sh](https://img.shields.io/badge/app-Now.sh-lightgrey.svg)](https://readium2.now.sh)
[![NPM](https://img.shields.io/npm/v/r2-streamer-js.svg)](https://www.npmjs.com/package/r2-streamer-js) [![David](https://david-dm.org/readium/r2-streamer-js/status.svg)](https://david-dm.org/readium/r2-streamer-js) [![Travis](https://travis-ci.org/readium/r2-streamer-js.svg?branch=develop)](https://travis-ci.org/readium/r2-streamer-js) [![Heroku](https://img.shields.io/badge/app-Heroku-blue.svg)](https://readium2.herokuapp.com) [![Now.sh](https://img.shields.io/badge/app-Now.sh-lightgrey.svg)](https://readium2.now.sh)

THIS SOFTWARE IS **ALPHA**!

Expand All @@ -19,11 +19,11 @@ Public APIs are not stable. The internal logical architecture and physical code

## GitHub repository

https://github.com/edrlab/r2-streamer-js
https://github.com/readium/r2-streamer-js

There is no [github.io](https://edrlab.github.io/r2-streamer-js) site for this project (no [gh-pages](https://github.com/edrlab/r2-streamer-js/tree/gh-pages) branch).
There is no [github.io](https://readium.github.io/r2-streamer-js) site for this project (no [gh-pages](https://github.com/readium/r2-streamer-js/tree/gh-pages) branch).

Wiki documentation is not used, instead there are Markdown files inside the repository ([docs](https://github.com/edrlab/r2-streamer-js/tree/develop/docs) folder).
Wiki documentation is not used, instead there are Markdown files inside the repository ([docs](https://github.com/readium/r2-streamer-js/tree/develop/docs) folder).

Note that there are currently no API docs for the source code.

Expand Down Expand Up @@ -67,15 +67,15 @@ import { Publication } from "r2-streamer-js/dist/es5/src/models/publication";

## Dependencies

https://david-dm.org/edrlab/r2-streamer-js
https://david-dm.org/readium/r2-streamer-js

A [package-lock.json](https://github.com/edrlab/r2-streamer-js/blob/develop/package-lock.json) is provided (modern NPM alternative to `npm-shrinkwrap.json`).
A [package-lock.json](https://github.com/readium/r2-streamer-js/blob/develop/package-lock.json) is provided (modern NPM alternative to `npm-shrinkwrap.json`).

A [yarn.lock](https://github.com/edrlab/r2-streamer-js/blob/develop/yarn.lock) file is also provided at the root of the source tree (Yarn is not recommended anymore to manage this project's NPM dependencies, due to several experienced build-breaking bugs).
A [yarn.lock](https://github.com/readium/r2-streamer-js/blob/develop/yarn.lock) file is also provided at the root of the source tree (Yarn is not recommended anymore to manage this project's NPM dependencies, due to several experienced build-breaking bugs).

## Continuous Integration

https://travis-ci.org/edrlab/r2-streamer-js
https://travis-ci.org/readium/r2-streamer-js

TravisCI builds are triggered automatically at every Git "push" in the `develop` branch.

Expand Down Expand Up @@ -139,16 +139,16 @@ Command line steps (optional Yarn):

### HTTP API

https://github.com/edrlab/r2-streamer-js/blob/develop/docs/http.md
https://github.com/readium/r2-streamer-js/blob/develop/docs/http.md

### Support for remote publications

https://github.com/edrlab/r2-streamer-js/blob/develop/docs/remote-epub.md
https://github.com/readium/r2-streamer-js/blob/develop/docs/remote-epub.md

### Support for OPDS feeds

https://github.com/edrlab/r2-streamer-js/blob/develop/docs/opds.md
https://github.com/readium/r2-streamer-js/blob/develop/docs/opds.md

### Support for encrypted content

https://github.com/edrlab/r2-streamer-js/blob/develop/docs/encryption.md
https://github.com/readium/r2-streamer-js/blob/develop/docs/encryption.md
2 changes: 1 addition & 1 deletion docs/opds.md
Expand Up @@ -4,7 +4,7 @@

https://readium2.herokuapp.com/opds/

The EPUB files referenced from the OPDS feeds are remotely accessed using HTTP partial byte range requests in order to support loading large publications (e.g. audio / video EPUB3 files). More information here: https://github.com/edrlab/r2-streamer-js/blob/develop/docs/remote-epub.md
The EPUB files referenced from the OPDS feeds are remotely accessed using HTTP partial byte range requests in order to support loading large publications (e.g. audio / video EPUB3 files). More information here: https://github.com/readium/r2-streamer-js/blob/develop/docs/remote-epub.md

## A selection of public OPDS feeds:

Expand Down
4 changes: 2 additions & 2 deletions docs/origin.md
Expand Up @@ -8,7 +8,7 @@ Furthermore, every publications' "webpub manifest" JSON (and their linked resour

So, the full "origin" of *all* publications looks like (for example): `https://127.0.0.1:8080`, which can be decomposed to the URL format: `SCHEME://IP:PORT`. The URL syntax used to identify specific publications is: `SCHEME://IP:PORT/pub/ID`, and the syntax used to reference specific assets within a given publication is `SCHEME://IP:PORT/pub/ID/PATH/TO/RESOURCE`.

(more information at https://github.com/edrlab/r2-streamer-js/blob/develop/docs/http.md )
(more information at https://github.com/readium/r2-streamer-js/blob/develop/docs/http.md )

## Problem description

Expand All @@ -26,7 +26,7 @@ For example, a URL such as `SCHEME://IP:PORT/pub/ID/PATH/TO/RESOURCE` (let's say

## Electron

See: https://github.com/edrlab/r2-navigator-js/issues/2
See: https://github.com/readium/r2-navigator-js/issues/2

Key APIs:

Expand Down
4 changes: 2 additions & 2 deletions docs/remote-epub.md
Expand Up @@ -6,7 +6,7 @@ https://readium2.herokuapp.com/url/

Technical note: EPUB files served by `readium2-streamer-js` are normally fetched from the local filesystem. However, remote publications (such as those referenced from OPDS feeds) must be fetched efficiently across the network. This is done using HTTP partial byte range requests (rather than full EPUB download), in order to support large publications with acceptable levels of performance and memory consumption (e.g. audio / video EPUB3 files).

More information about OPDS support here: https://github.com/edrlab/r2-streamer-js/blob/develop/docs/opds.md
More information about OPDS support here: https://github.com/readium/r2-streamer-js/blob/develop/docs/opds.md

## A selection of public EPUB URLs:

Expand Down Expand Up @@ -38,4 +38,4 @@ https://rawgit.com/pmstss/epub-books/master/kusamakura-japanese-vertical-writing
https://readium2.herokuapp.com/pub/aHR0cHM6Ly9yYXdnaXQuY29tL3Btc3Rzcy9lcHViLWJvb2tzL21hc3Rlci9rdXNhbWFrdXJhLWphcGFuZXNlLXZlcnRpY2FsLXdyaXRpbmcuZXB1Yg==/

Many more test EPUBs here: https://github.com/pmstss/epub-books
...and of course more EPUBs available from OPDS feeds: https://github.com/edrlab/r2-streamer-js/blob/develop/docs/opds.md
...and of course more EPUBs available from OPDS feeds: https://github.com/readium/r2-streamer-js/blob/develop/docs/opds.md
12 changes: 6 additions & 6 deletions package.json
Expand Up @@ -27,12 +27,12 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/edrlab/r2-streamer-js.git"
"url": "git+https://github.com/readium/r2-streamer-js.git"
},
"author": {
"name": "EDRLab",
"organization": "EDRLab",
"url": "http://github.com/edrlab/"
"name": "Readium Foundation",
"organization": "Readium Foundation",
"url": "http://github.com/readium/"
},
"license": "BSD-3-Clause",
"licenses": [
Expand All @@ -42,9 +42,9 @@
}
],
"bugs": {
"url": "https://github.com/edrlab/r2-streamer-js/issues"
"url": "https://github.com/readium/r2-streamer-js/issues"
},
"homepage": "https://github.com/edrlab/r2-streamer-js",
"homepage": "https://github.com/readium/r2-streamer-js",
"dependencies": {
"ajv": "^6.5.3",
"css2json": "^0.0.4",
Expand Down
2 changes: 1 addition & 1 deletion tools/gitrev.js
Expand Up @@ -31,7 +31,7 @@ try {
if (branch.indexOf(detached) === 0) {
branch = branch.substr(detached.length);
}
const gitUrlBase = "https://github.com/edrlab/r2-streamer-js/";
const gitUrlBase = "https://github.com/readium/r2-streamer-js/";
json = {
"short": git.short(),
"long": git.long(),
Expand Down

0 comments on commit cc4dc02

Please sign in to comment.