mirror of
https://github.com/Febbweiss/pdf-reader.git
synced 2026-03-04 22:25:38 +00:00
Feature: add .gitignore
This commit is contained in:
30
README.md
Normal file
30
README.md
Normal file
@@ -0,0 +1,30 @@
|
||||
PDF-Reader is a small web application listing PDF documents and allowing to visualize them.
|
||||
|
||||
|
||||
Building :
|
||||
---
|
||||
|
||||
This project is built using [Bower](http://bower.io).
|
||||
Just install it and run :
|
||||
|
||||
```
|
||||
bower install
|
||||
```
|
||||
|
||||
How it works :
|
||||
---
|
||||
|
||||
Written in AngularJS, PDF-Reader calls a resource (_/data/documents.json_) providing a list of documents such as :
|
||||
|
||||
```
|
||||
[{"title": "My report", "link": "report.pdf"]
|
||||
```
|
||||
|
||||
The list is rendering such as a paginated table with a quick filter input. Clicking on the _View_ button load the document in the right side pane.
|
||||
|
||||
Documents are stored in a _documents_ folder.
|
||||
|
||||
Licence :
|
||||
----------
|
||||
|
||||
Source code is under [MIT Licence](http://opensource.org/licenses/mit-license.php)
|
||||
Reference in New Issue
Block a user