Skip to content

Commit

Permalink
docs: adding and example
Browse files Browse the repository at this point in the history
  • Loading branch information
cereallarceny committed Feb 1, 2024
1 parent 9dd1811 commit f16663b
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 11 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@

<div style="display: flex; flex-direction: column; align-items: center;">
<img src="apps/web/public/logo.svg" alt="Flipbook Logo" width="200" />
<h1 style="margin-top: 10px">Flipbook</h1>
<p align="center">
<img src="apps/web/public/logo.svg" alt="Flipbook" width="200" />
<h1 style="text-align: center; margin-top: 10px;">Flipbook</h1>
</p>

[![Build Status](https://travis-ci.org/cereallarceny/flipbook.svg?branch=main)](https://travis-ci.org/cereallrceny/flipbook)
[![Coverage Status](https://coveralls.io/repos/github/cereallarceny/flipbook/badge.svg?branch=main)](https://coveralls.io/github/cereallarceny/flipbook?branch=main)
</div>
[![Build Status](https://travis-ci.org/cereallarceny/flipbook.svg?branch=main)](https://travis-ci.org/cereallrceny/flipbook)
[![Coverage Status](https://coveralls.io/repos/github/cereallarceny/flipbook/badge.svg?branch=main)](https://coveralls.io/github/cereallarceny/flipbook?branch=main)

## Getting Started

Flipbook is a series of libraries that you can use in any web, mobile, or desktop application that enable the writing and reading of QR codes that contain larger payloads than traditional QR codes. This is done by creating a series of QR codes that are stitched together into an animated GIF, called a "Flipbook". This Flipbook can then be scanned by the reader library and subsequently reassembled into the original payload.

![Flipbook Example](./docs/flipbook-qr.gif)

**[Download Reader](https://flipbook.codes)**

### Why?

The ubiquity of QR codes in daily life has made them a popular tool for sharing information. But the medium is inherently limited to payloads of small sizes. While larger payloads can be supported (to a point), the resulting QR code becomes too difficult to scan reliably.

### Are there any size limitations?

In theory, no. It would simply be a matter of how long it takes for the writer to encode the payload into a Flipbook, and how long it takes for the reader to decode the Flipbook back into the original payload.
Expand All @@ -19,10 +27,6 @@ In theory, no. It would simply be a matter of how long it takes for the writer t

Anything! Books... movies... music... software... anything that can be represented as a series of bytes can be encoded into a Flipbook.

### Why?

The ubiquity of QR codes in daily life has made them a popular tool for sharing information. But the medium is inherently limited to payloads of small sizes. While larger payloads can be supported (to a point), the resulting QR code becomes too difficult to scan reliably.

## Libraries

- Writer (Typescript): [Documentation](./packages/writer) | [NPM Package](https://www.npmjs.com/package/@flipbook/writer)
Expand Down
2 changes: 1 addition & 1 deletion apps/web/app/writer/page.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { Sponsor, Star } from './components/github-button';
// TODO: Release reader and writer as separate packages to NPM: @flipbook/reader and @flipbook/writer

// ----- UI/UX ----- //
// TODO: Finish readme
// TODO: Write the following readmes: reader, writer, and contributing
// TODO: Add Github actions for testing and such and show badge and coverage on the README
// TODO: Create a "install" version of the reader
// TODO: Create homepage to advertise the reader
Expand Down
Binary file added docs/flipbook-qr.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f16663b

Please sign in to comment.