Skip to content

Commit 0c667e0

Browse files
committed
udpates readme with license info
1 parent 31f7771 commit 0c667e0

File tree

1 file changed

+39
-1
lines changed

1 file changed

+39
-1
lines changed

build/Readme.txt

+39-1
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,42 @@ default values applied when they are not specified:
2424
* extensions = comma seperated list of file extensions that our PDFs have
2525
the default is ".pdf"
2626
* umbracoFileProperty = the property of the media type that contains files
27-
the default is "umbracoFile"
27+
the default is "umbracoFile"
28+
29+
*****************************************************************************
30+
MANUAL INSTALLATION
31+
*****************************************************************************
32+
33+
To add this to your site, drop the files from this zip file in the bin folder.
34+
35+
You'll need to add a new Indexer & Searcher to ~/Config/ExamineSettings.config
36+
called: "PDFIndexer" & "PDFSearcher"
37+
38+
<add name="PDFIndexer"
39+
type="UmbracoExamine.PDF.PDFIndexer, UmbracoExamine.PDF"
40+
extensions=".pdf"
41+
umbracoFileProperty="umbracoFile" />
42+
43+
<add name="PDFSearcher"
44+
type="UmbracoExamine.UmbracoExamineSearcher, UmbracoExamine" />
45+
46+
and add a new Index Set to ~/Config/ExamineIndex.config called "PDFIndexSet":
47+
48+
<IndexSet SetName="PDFIndexSet" IndexPath="~/App_Data/TEMP/ExamineIndexes/PDFs" />
49+
50+
*****************************************************************************
51+
LICENSE
52+
*****************************************************************************
53+
54+
The source code for UmbracoExamine.PDF is licensed under the MIT license.
55+
The license to use iTextSharp is licensed under the AGPL license.
56+
See their license information for full details:
57+
https://github.com/itext/itextsharp/blob/master/LICENSE.md
58+
59+
According to iText if you use this software in a closed source scenario,
60+
you will need to procure a commercial license of iText:
61+
62+
> In case you application is MIT licensed and iText is an add-on you are
63+
> entitled to use the iText AGPL version for this application.
64+
> In case a third party integrates your open source application into a
65+
> closed source application, he/she will have to procure a commercial license of iText.

0 commit comments

Comments
 (0)