Skip to content

Commit

Permalink
Added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
wobba committed Nov 20, 2018
1 parent 1273791 commit 2ffa429
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 12 deletions.
29 changes: 17 additions & 12 deletions Pzl.Ext.PDFExport/README.md
@@ -1,13 +1,26 @@
## pzl-ext-pdf-export
# Save and export as PDF by Puzzlepart

This is where you include your WebPart documentation.
A global list customizer which adds functionality to all document libraries in SharePoint Online to convert one or more documents in-place to PDF, or download one or more documents as a PDF. When selecting multiple documents for download they will be downloaded as a zip file.

![Screenshot](./screenshot.png "Screenshot")

## Installing the solution

- Upload and Deploy the file [pzl-ext-highlight-home.sppkg](./pzl-ext-pdf-export.sppkg) to your tenant app catalog. ![TrustSolution](./screenshot-2.png "Trust solution")
* If created the tenant app catalog can be reached via `https://<tenant>-admin.sharepoint.com/_layouts/15/online/ManageAppCatalog.aspx`.
* You need to be a SharePoint Administrator to upload this solution.
- Navigate to a document library and select one or more files and you should see the PDF options in the document ribbon.

_Note: It may take a little while before it shows the first time after install._

### Building the code

Ensure that at least SPFx v1.6 is installed.

```bash
git clone the repo
git clone https://github.com/Puzzlepart/spfx-solutions.git
cd spfx-solutions/Pzl.Ext.PDFExport
npm i
npm i -g gulp
gulp
```

Expand All @@ -16,11 +29,3 @@ This package produces the following:
* lib/* - intermediate-stage commonjs build artifacts
* dist/* - the bundled script, along with other resources
* deploy/* - all resources which should be uploaded to a CDN.

### Build options

gulp clean - TODO
gulp test - TODO
gulp serve - TODO
gulp bundle - TODO
gulp package-solution - TODO
Binary file added Pzl.Ext.PDFExport/pzl-ext-pdf-export.sppkg
Binary file not shown.
Binary file added Pzl.Ext.PDFExport/screenshot-2.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Pzl.Ext.PDFExport/screenshot.png
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 2ffa429

Please sign in to comment.