Skip to content

Commit 53f1df4

Browse files
committed
docs: update documentation
1 parent d7564a8 commit 53f1df4

2 files changed

Lines changed: 22 additions & 11 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ SimplePDF Embed operates in two distinct modes with different privacy characteri
7979
- Submissions are stored and accessible via your dashboard
8080
- Enables webhook integration for form automation (Basic plan+) - [learn more](https://simplepdf.com/help/how-to/configure-webhooks-pdf-form-submissions)
8181
- Custom branding - remove "Powered by SimplePDF", add your own logo, headless mode... (Pro plan+) - [learn more](https://simplepdf.com/help/how-to/customize-the-pdf-editor-and-add-branding)
82-
- Use your own S3/Azure Blob Storage for PDF documents (Pro plan+) - [learn more](https://simplepdf.com/help/how-to/use-your-own-s3-bucket-storage-for-pdf-form-submissions)
82+
- Use your own storage for PDF documents: S3-compatible or Azure Blob Storage (Pro plan+), SharePoint (Premium plan) - [learn more](https://simplepdf.com/help/how-to/use-your-own-s3-bucket-storage-for-pdf-form-submissions)
8383

8484
**Data Flow:**
8585

@@ -97,7 +97,7 @@ User fills PDF -> Clicks Submit -> Metadata sent to SimplePDF -> Webhook trigger
9797
| Submissions collected | No | Yes (Basic plan+) |
9898
| Branding | "Powered by SimplePDF" | Customizable (Pro plan+) |
9999
| Webhooks | Not available | Available (Basic plan+) |
100-
| BYOS (S3/Azure) | Not available | Available (Pro plan+) |
100+
| BYOS (S3/Azure/SharePoint) | Not available | Available (plan-dependent) |
101101
| Price | Free | [Paid plans](https://simplepdf.com/pricing) |
102102

103103
# Branding Configuration
@@ -166,10 +166,10 @@ SimplePDF Embed uses a **fully client-side architecture** for PDF processing:
166166
| SimplePDF Servers |
167167
| Submission storage, webhooks, etc. |
168168
+-----------------------------------------------------+
169-
| (BYOS - Pro plan, optional)
169+
| (BYOS - paid plans, optional)
170170
v
171171
+-----------------------------------------------------+
172-
| Your Own Storage (S3/Azure Blob Storage) |
172+
| Your Own Storage (S3/Azure Blob Storage/SharePoint)|
173173
| For HIPAA compliance, data residency, etc. |
174174
+-----------------------------------------------------+
175175
```
@@ -230,12 +230,12 @@ SimplePDF handles PDF generation and storage so you don't have to. When users su
230230
| ------------------------------------------- | ----------------------------- | ------------------------------------ |
231231
| `submit` with `downloadCopyOnDevice: true` | Browser downloads the PDF | End-user saves their work |
232232
| `submit` with `downloadCopyOnDevice: false` | PDF sent to SimplePDF servers | Server-side collection via webhooks |
233-
| S3/Azure Integration | PDF stored in your bucket | Programmatic access via your storage |
233+
| S3/Azure/SharePoint Integration | PDF stored in your storage | Programmatic access via your storage |
234234

235235
**Available integrations:**
236236

237237
- **Webhooks**: Get notified when submissions are received - [Configure webhooks](https://simplepdf.com/help/how-to/configure-webhooks-pdf-form-submissions)
238-
- **Bring Your Own Storage (BYOS)**: Store submissions directly in your storage - [S3 setup](https://simplepdf.com/help/how-to/use-your-own-s3-bucket-storage-for-pdf-form-submissions) / [Azure setup](https://simplepdf.com/help/how-to/use-your-own-azure-blob-storage-for-pdf-documents)
238+
- **Bring Your Own Storage (BYOS)**: Store submissions directly in your storage - [S3 setup](https://simplepdf.com/help/how-to/use-your-own-s3-bucket-storage-for-pdf-form-submissions) / [Azure setup](https://simplepdf.com/help/how-to/bring-your-own-azure-blob-storage-for-pdf-storage) / [SharePoint setup](https://simplepdf.com/help/how-to/connect-sharepoint-as-your-own-storage-for-pdf-submissions)
239239

240240
# Page Manipulation
241241

react/README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,16 @@ Easily add [SimplePDF](https://simplepdf.com) to your React app, by using the `E
3636
npm install @simplepdf/react-embed-pdf
3737
```
3838

39+
## Related documentation
40+
41+
For shared product behavior and account-specific features, see the main embed README:
42+
43+
- [Data Privacy & `companyIdentifier`](../README.md#data-privacy--companyidentifier)
44+
- [Branding Configuration](../README.md#branding-configuration)
45+
- [Retrieving PDF Data](../README.md#retrieving-pdf-data)
46+
- [Page Manipulation](../README.md#page-manipulation)
47+
- [FAQ](../README.md#faq)
48+
3949
## How to use it
4050

4151
The `EmbedPDF` component has two modes: `"modal"` (default) and `"inline"`.
@@ -48,10 +58,9 @@ _The features below require a [SimplePDF account](https://simplepdf.com/pricing#
4858

4959
While the component does not require any account to be used (without any limits), you can specify the `companyIdentifier` to:
5060

51-
- [Automatically collect your users' submissions](https://simplepdf.com/embed)
52-
- [Customize the editor and use your own branding](https://simplepdf.com/help/how-to/customize-the-pdf-editor-and-add-branding)
53-
- [Configure webhooks](https://simplepdf.com/help/how-to/configure-webhooks-pdf-form-submissions)
54-
- **Use your own storage**: [S3-compatible](https://simplepdf.com/help/how-to/use-your-own-s3-bucket-storage-for-pdf-form-submissions) / [Azure Blob Storage](https://simplepdf.com/help/how-to/use-your-own-azure-blob-storage-for-pdf-documents)
61+
- [Automatically collect your users' submissions, configure webhooks, and use BYOS](../README.md#retrieving-pdf-data)
62+
- [Customize branding and white-label behavior](../README.md#branding-configuration)
63+
- [Use company mode instead of the default mode](../README.md#data-privacy--companyidentifier)
5564

5665
_Example_
5766

@@ -120,9 +129,11 @@ import { EmbedPDF } from '@simplepdf/react-embed-pdf';
120129
/>;
121130
```
122131

132+
See [Data Privacy & `companyIdentifier`](../README.md#data-privacy--companyidentifier) for reserved values and mode behavior.
133+
123134
### Programmatic Control
124135

125-
_Some actions require a SimplePDF account_
136+
_Some actions require a SimplePDF account. See [Retrieving PDF Data](../README.md#retrieving-pdf-data) for storage and submission behavior._
126137

127138
Use `const { embedRef, actions } = useEmbed();` to programmatically control the embed editor:
128139

0 commit comments

Comments
 (0)