diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2e215fa7..86f881d3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,9 +1,8 @@ # Contributing * All PRs are welcome in the `develop` branch. -* Please, stick to the repo's defined [Purpose](README.md#purpose) and try to write your code as readable as possible. +* Please, stick to the repo's defined [Purpose](https://github.com/vbuch/node-signpdf#purpose) and try to write your code as readable as possible. * We do code reviews and may ask you to change things before we merge code. -* This is a git-flow repo. We use the default git flow with a `v` version prefix. You shouldn't care much while writeing a feature but good to know. * Note that [gitmoji](https://gitmoji.carloscuesta.me/) is used in the commit messages. That's not a must but we think it's nice. ## Contributors diff --git a/README.md b/README.md index 86f47cf5..a5d6746f 100644 --- a/README.md +++ b/README.md @@ -134,6 +134,6 @@ const signedPdf = signer.sign(pdfBuffer, certificateBuffer); * [node-forge](https://github.com/digitalbazaar/forge) is an awesome package written in pure JavaScript and [supports signing in detached mode](https://github.com/digitalbazaar/forge/pull/605). Many thanks to all the guys who wrote and maintain it. * Thanks to the guys of [PDFKit](https://github.com/foliojs/pdfkit) as well. They've made PDF generation incredibly easy. -## [Contributing](CONTRIBUTING.md) +## [Contributing](https://github.com/vbuch/node-signpdf/blob/develop/CONTRIBUTING.md) -## [Changelog](CHANGELOG.md) +## [Changelog](https://github.com/vbuch/node-signpdf/blob/develop/CHANGELOG.md) diff --git a/packages/placeholder-pdfkit010/README.md b/packages/placeholder-pdfkit010/README.md index f7618ba6..091d43f9 100644 --- a/packages/placeholder-pdfkit010/README.md +++ b/packages/placeholder-pdfkit010/README.md @@ -14,7 +14,7 @@ You will need `$ npm i -S @signpdf/signpdf @signpdf/placeholder-pdfkit010 node-f ## Notes * Make sure to have a look at the docs of the [@signpdf family of packages](https://github.com/vbuch/node-signpdf/). -* Feel free to copy and paste any part of this code. See its defined [Purpose](#purpose). +* Feel free to copy and paste any part of this code. See its defined [Purpose](https://github.com/vbuch/node-signpdf#purpose). ### Signature length diff --git a/packages/placeholder-plain/README.md b/packages/placeholder-plain/README.md index 2d19577e..ab383eca 100644 --- a/packages/placeholder-plain/README.md +++ b/packages/placeholder-plain/README.md @@ -18,8 +18,8 @@ Should you need some help go stright to [our GitHub Issues](https://github.com/v ## Notes * Make sure to have a look at the docs of the [@signpdf family of packages](https://github.com/vbuch/node-signpdf/). -* This lib does cover only basic scenarios of signing a PDF. If you have suggestions, ideas or anything, please [CONTRIBUTE](#contributing); -* Feel free to copy and paste any part of this code. See its defined [Purpose](#purpose). +* This lib does cover only basic scenarios of signing a PDF. If you have suggestions, ideas or anything, please [CONTRIBUTE](https://github.com/vbuch/node-signpdf/blob/develop/CONTRIBUTING.md); +* Feel free to copy and paste any part of this code. See its defined [Purpose](https://github.com/vbuch/node-signpdf#purpose). ### Signature length diff --git a/packages/signpdf/README.md b/packages/signpdf/README.md index bcfb4426..d7efed22 100644 --- a/packages/signpdf/README.md +++ b/packages/signpdf/README.md @@ -27,11 +27,11 @@ If your PDF does not contain a placeholder, we have helpers: * The process of signing a document is described in the [Digital Signatures in PDF](https://www.adobe.com/devnet-docs/etk_deprecated/tools/DigSig/Acrobat_DigitalSignatures_in_PDF.pdf) document. As Adobe's files are deprecated, [here is the standard as defined by ETSI](). * This lib: - * requires the [signature placeholder](#append-a-signature-placeholder) to already be in the document (There are helpers included that can try to add it); + * requires the [signature placeholder](https://github.com/vbuch/node-signpdf#append-a-signature-placeholder) to already be in the document (There are helpers included that can try to add it); * requires the `Contents` descriptor in the `Sig` be placed after the `ByteRange` one; - * takes `Buffer`s of the PDF and a P12 certificate to use when [signing](#generate-and-apply-signature); - * does cover only basic scenarios of signing a PDF. If you have suggestions, ideas or anything, please [CONTRIBUTE](#contributing); -* Feel free to copy and paste any part of this code. See its defined [Purpose](#purpose). + * takes `Buffer`s of the PDF and a P12 certificate to use when [signing](https://github.com/vbuch/node-signpdf/#generate-and-apply-signature); + * does cover only basic scenarios of signing a PDF. If you have suggestions, ideas or anything, please [CONTRIBUTE](https://github.com/vbuch/node-signpdf/blob/develop/CONTRIBUTING.md); +* Feel free to copy and paste any part of this code. See its defined [Purpose](https://github.com/vbuch/node-signpdf#purpose). ### PAdES compliant signatures diff --git a/packages/utils/README.md b/packages/utils/README.md index 5db93909..5f04e511 100644 --- a/packages/utils/README.md +++ b/packages/utils/README.md @@ -21,4 +21,4 @@ const pdfToSign = plainAddPlaceholder({ ## Notes -* Feel free to copy and paste any part of this code. See its defined [Purpose](#purpose). +* Feel free to copy and paste any part of this code. See its defined [Purpose](https://github.com/vbuch/node-signpdf#purpose).