Skip to content

Commit

Permalink
Links from readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
vbuch committed Oct 5, 2023
1 parent a228b0a commit 1db93bf
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 12 deletions.
3 changes: 1 addition & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion packages/placeholder-pdfkit010/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions packages/placeholder-plain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
8 changes: 4 additions & 4 deletions packages/signpdf/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](<https://ec.europa.eu/digital-building-blocks/wikis/display/DIGITAL/Standards+and+specifications#Standardsandspecifications-PAdES(PDFAdvancedElectronicSignature)BaselineProfile>).
* 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

Expand Down
2 changes: 1 addition & 1 deletion packages/utils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

0 comments on commit 1db93bf

Please sign in to comment.