diff --git a/README.md b/README.md index 10e60c6..300d9b8 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,58 @@ +![](./logo-banner2.png) + # DynamicPDF API - Node.js Client -A NodeJS Client API that uses the DynamicPDF API to create, merge, split, form fill, stamp, secure/encrypt PDF documents. +The NodeJS Client API uses the DynamicPDF Cloud API to create, merge, split, form fill, stamp, secure/encrypt PDF documents. For more information please visit [DynamicPDF Cloud API](https://cloud.dynamicpdf.com/ "DynamicPDF Cloud API Homepage"). Examples using this client library can be taken from [nodejs-client-examples](https://github.com/dynamicpdf-api/nodejs-client-examples "nodejs-client-examples at GitHub"). Support for other languages/platforms can be found on [GitHub](https://github.com/dynamicpdf-api "DynamicPDF Cloud API at GitHub"). + +## Installation + +To install the prebuilt binary, use [`npm`](https://docs.npmjs.com/). Complete instructions can be found at [@dynamicpdf/api](https://www.npmjs.com/package/@dynamicpdf/api). To install for the first time, use the following command. + +```bash +npm i @dynamicpdf/api +``` + +## Documentation + +* Obtain overview documentation for the DynamicPDF Cloud API Client libraries from the [Cloud API Users Guide](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/cloud-api-client-libraries). +* Access the documentation for each particular endpoint from the following Users Guide pages. + +| Endpoint | REST Endpoint | REST Endpoint Client Library | Description | +| ------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | +| `dlex-layout` | [Cloud API Users Guide - `dlex-layout`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-dlex-layout) | [`dlex-layout`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-dlex-layout) | Returns a PDF after processing a DLEX file with it's associated JSON data. | +| `image-info` | [Cloud API Users Guide - `image-info`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-image-info) | [`image-info`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-image-info) | Returns image metadata as a JSON document. | +| `pdf` | [Cloud API Users Guide - `pdf`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-pdf) | [`pdf`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-pdf) | Returns a PDF after performing one of the pdf endpoint's tasks (`page`, `dlex`, `image`) or merging. | +| `pdf-info` | [Cloud API Users Guide - `pdf-Info`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-pdf-info) | [`pdf-info`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-pdf-info) | Returns PDF metadata as a JSON document. | +| `pdf-text` | [Cloud API Users Guide - `pdf-text`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-pdf-text) | [`pdf-text`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-pdf-text) | Returns the text from a PDF as a JSON document. | +| `pdf-xmp` | [Cloud API Users Guide - `pdf-xmp`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/cloud-api-pdf-xmp) | [`pdf-xmp`](https://cloud.dynamicpdf.com/docs/usersguide/cloud-api/client-libraries/client-api-pdf-xmp) | Returns XMP metadata from a PDF. | + +## REST Client + +* The `nodejs-client` uses the node.js built-in HTTP module (https://nodejs.dev/learn/the-nodejs-http-module). + +## **Tutorials** + +The following table lists the tutorial project or file name. + +| Tutorial Title | Tutorial Location | +| -------------------------------------------------- | ------------------------------------------------------------ | +| Merging PDFs | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/merging-pdfs | +| Completing an AcroForm | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/form-completion | +| Creating a PDF Using a DLEX and the `pdf` Endpoint | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/dlex-pdf-endpoint | +| Adding Bookmarks to a PDF | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/bookmarks | +| Creating a PDF Using the `dlex-layout` Endpoint | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/dlex-layout | +| Extracting Image Metadata | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/image-info | +| Extract PDF Metadata | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/pdf-info | +| Extracting PDF's Text | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/pdf-text | +| Extract XMP Metadata | https://cloud.dynamicpdf.com/docs/tutorials/cloud-api/pdf-xmp | -For more information please visit [DynamicPDF Cloud API](https://cloud.dynamicpdf.com/ "DynamicPDF Cloud API Homepage") +# Support -Examples for this client library can be taken from [nodejs-client-examples](https://github.com/dynamicpdf-api/nodejs-client-examples "nodejs-client-examples at GitHub") +The primary source for the DynamicPDF Cloud API support is through [Stack Overflow](https://stackoverflow.com/questions/tagged/dynamicpdf-api). Please use the "[dynamicpdf-api](https://stackoverflow.com/questions/tagged/dynamicpdf-api)" tag to ask questions. Our support team actively monitors the tag and responds promptly to any questions. Also, let us know you asked the question by following up with an email to [support@dynamicpdf.com](mailto:support@dynamicpdf.com). -Support for other languages/platforms can be found at [GitHub](https://github.com/dynamicpdf-api "DynamicPDF Cloud API at GitHub") +## Pro Plan Subscribers[#](https://cloud.dynamicpdf.com/support#pro-plan-subscribers) +Ticket support is available to Pro Plan subscribers. But we still encourage you to help the community by posting on Stack Overflow when possible. You can also email [support@dynamicpdf.com](mailto:support@dynamicpdf.com) if you need to ask something specific to your use case that may not help the DynamicPDF Cloud API community. +# License +The `nodejs-client` library is licensed under the [MIT License](./LICENSE). diff --git a/logo-banner2.png b/logo-banner2.png new file mode 100644 index 0000000..aeb1403 Binary files /dev/null and b/logo-banner2.png differ