README.md
changeset 0 266fe36d11dd
child 3 a062019c2926
equal deleted inserted replaced
-1:000000000000 0:266fe36d11dd
       
     1 # Thingfish-Processor-PDF
       
     2 
       
     3 home
       
     4 : https:/bitbucket.org/mahlon/Thingfish-Processor-PDF
       
     5 
       
     6 
       
     7 ## Description
       
     8 
       
     9 This is a basic pdf processor plugin for the Thingfish digital asset
       
    10 manager.  It extracts PDF metadata from uploaded files.
       
    11 
       
    12 
       
    13 ## Prerequisites
       
    14 
       
    15 * Ruby
       
    16 
       
    17 
       
    18 ## Installation
       
    19 
       
    20     $ gem install thingfish-processor-pdf
       
    21 
       
    22 
       
    23 ##  Usage
       
    24 
       
    25 Simply enable this processor in the *Thingfish* section of your configuration:
       
    26 
       
    27     --
       
    28     thingfish:
       
    29       processors:
       
    30         - pdf
       
    31 
       
    32 
       
    33 ## Contributing
       
    34 
       
    35 You can check out the current development source with Mercurial via its
       
    36 {project page}[http://bitbucket.org/mahlon/thingfish-processor-pdf].
       
    37 
       
    38 After checking out the source, run:
       
    39 
       
    40     $ rake newb
       
    41 
       
    42 This task will install any missing dependencies, run the tests/specs,
       
    43 and generate the API documentation.
       
    44 
       
    45 
       
    46 ## License
       
    47 
       
    48 Copyright (c) 2016, Mahlon E. Smith
       
    49 All rights reserved.
       
    50 
       
    51 Redistribution and use in source and binary forms, with or without
       
    52 modification, are permitted provided that the following conditions are met:
       
    53 
       
    54 * Redistributions of source code must retain the above copyright notice,
       
    55   this list of conditions and the following disclaimer.
       
    56 
       
    57 * Redistributions in binary form must reproduce the above copyright notice,
       
    58   this list of conditions and the following disclaimer in the documentation
       
    59   and/or other materials provided with the distribution.
       
    60 
       
    61 * Neither the name of the author/s, nor the names of the project's
       
    62   contributors may be used to endorse or promote products derived from this
       
    63   software without specific prior written permission.
       
    64 
       
    65 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
       
    66 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
       
    67 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
       
    68 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
       
    69 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
       
    70 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
       
    71 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
       
    72 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
       
    73 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
       
    74 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
       
    75 
       
    76