Merge pull request pdfme#7 from hand-dot/feature/review

initial REVIEW for pdfme
nightvisi0n · Feb 2, 2022 · 0dea982 · 0dea982
2 parents ba02bfc + 76f57e2
commit 0dea982
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -6,7 +6,7 @@
 
 # PDFME
 
-> pdfme is now beta version. Please report any issues or suggestions from [Help page](/help) or [edit this page.](https://github.com/hand-dot/pdfme-beta/tree/main/website/docs/getting-started.md)
+> pdfme is now in beta version. Please report any issues or suggestions from [Help page](/help) or [edit this page.](https://github.com/hand-dot/pdfme-beta/tree/main/website/docs/getting-started.md)
 
 TypeScript base PDF generator and React base UI.
 Open source, developed by the community, and completely free to use under the MIT license!

diff --git a/website/docs/getting-started.md b/website/docs/getting-started.md
@@ -6,18 +6,18 @@ sidebar_position: 1
 
 :::caution
 
-pdfme is now beta version. Please report any issues or suggestions from [Help page](/help) or [edit this page.](https://github.com/hand-dot/pdfme-beta/tree/main/website/docs/getting-started.md)
+pdfme is now in beta version. Please report any issues or suggestions from [Help page](/help) or [edit this page.](https://github.com/hand-dot/pdfme-beta/tree/main/website/docs/getting-started.md)
 :::
 
 ## Introduction
 
-pdfme was created to simplify PDF generation and design. It is especially useful for the following use cases.
+pdfme was created to simplify the design and generation process of a PDF. It is especially useful for the following use cases:
 
 - Need to create a designed PDF with short code.
-- Need to integrate PDF design features into applications.
+- Need to integrate PDF editor features into an application.
 - Need to create a large number of PDFs without compromising performance
 
-As a example, the author's service [https://labelmake.jp/](https://labelmake.jp/) can create more than 100 varieties of PDFs and generates more than 100,000 PDF files per month.
+As an example, the author's service [https://labelmake.jp/](https://labelmake.jp/) can create more than 100 varieties of PDFs and generates more than 100,000 PDF files per month.
 
 ## Installation
 
@@ -48,8 +48,8 @@ import { Template, generate, Designer, Form, Viewer } from 'pdfme';
 
 ## Template
 
-The core of pdfme's library is Template. All objects use Template.  
-A template can be divided into two parts: fixed and variable. They are called basePdf and schemas.
+The core of pdfme library are Templates. Templates are used everywhere.  
+A template can be divided into two parts: a fixed part and a variable part. We call them basePdf and schema.
 The following image is a good illustration of a template.
 
 ![](/img/template.png)

diff --git a/website/src/components/HomepageFeatures.tsx b/website/src/components/HomepageFeatures.tsx
@@ -10,21 +10,22 @@ type FeatureItem = {
 
 const FeatureList: FeatureItem[] = [
   {
-    title: 'Fast PDF Generator',
+    title: 'A fast PDF Generator',
     description: (
       <>
-        Works on node and browser. Use templates to generate PDF, Complex operations are not needed.
+        No complex operations are needed. Just use templates to generate PDFs.
+        Works on node and the browser. 
       </>
     ),
   },
   {
-    title: 'Easy PDF template design',
-    description: <>Anyone can easily create templates with the designer.</>,
+    title: 'An easy PDF template editor',
+    description: <>Anyone can easily create templates with the designer (tool).</>,
   },
   {
-    title: 'Simple JSON template',
+    title: 'Templates as structured JSON Data',
     description: (
-      <>Templates are JSON data that is easy to understand and handle.</>
+      <>Templates are JSON data that are easy to understand and handle.</>
     ),
   },
 ];

diff --git a/website/src/components/HomepageHeader.tsx b/website/src/components/HomepageHeader.tsx
@@ -18,7 +18,7 @@ export default function HomepageHeader() {
           <div className="col col--6">
             <h1 className="hero__title">{siteConfig.title}</h1>
             <p className="hero__subtitle">
-              TypeScript base PDF generator and React base UI. <br />
+              A TypeScript based PDF generator library, made with React.<br />
               Open source, developed by the community, and completely free to use under the MIT
               license!
             </p>
@@ -43,7 +43,7 @@ export default function HomepageHeader() {
               </div>
               <div className="admonition-content">
                 <p>
-                  pdfme is now beta version. Please report any issues or suggestions from{' '}
+                  pdfme is now in beta version. Please report any issues or suggestions from{' '}
                   <Link to="/help">Help page</Link>
                 </p>
               </div>

diff --git a/website/src/pages/index.tsx b/website/src/pages/index.tsx
@@ -115,20 +115,18 @@ export default function Home(): JSX.Element {
                     <img src={'/img/template.png'} alt="Image alt text" title="Logo Title Text 1" />
                   </div>
                   <div className="card__body">
-                    <h4>Template is made of basePdf and schemas</h4>
+                    <h4>A template is made of a basePdf and the schema</h4>
                     <small>
-                      Templates are the core data structure of the pdfme library.
-                      <br />
-                      Once templates are created, they are reusable and can be used in the
-                      generator, form, and viewer.
+                      Templates are the core data structure of pdfme. Once a template is created, it
+                      is reusable within the generator, the form, and the viewer.
                     </small>
                   </div>
                   <div className="card__footer">
                     <Link
                       className="button button--lg button--primary button--block"
                       to="/docs/getting-started#template"
                     >
-                      Learn more about the Template
+                      Learn more about Templates
                     </Link>
                   </div>
                 </div>
@@ -174,7 +172,7 @@ export default function Home(): JSX.Element {
                 <a className="hash-link" href="#designer" title="Direct link to heading"></a>
               </h2>
               <p>
-                You can easily create a template by using the designer. It supports shortcuts such
+                You can easily create a template by using the designer (tool). It supports shortcuts such
                 as Copy, Paste, Undo, Redo, Ruler, and group selection.
               </p>
             </div>
@@ -190,7 +188,7 @@ export default function Home(): JSX.Element {
             <div className={clsx('col col--12 margin-vert--lg')}>
               <div className="text--center">
                 <p>
-                  You can easily integrate into your app.
+                  It's easy to integrate with your app.
                   <br />
                 </p>
                 <Link
@@ -241,14 +239,12 @@ export default function Home(): JSX.Element {
                     <small>
                       {mode === 'form' ? (
                         <div>
-                          You can use the template to generate a form for the user to input.
-                          <br />
-                          Generating a PDF with the values entered by the user can be easily
-                          achieved.
+                          You can use a template to generate a form to input.
+                          It needs a moment for the user to input the form and generate a filled Pdf
                         </div>
                       ) : (
                         <div>
-                          You can use the template to generate a viewer for the user to check the
+                          You can use a template to generate a viewer for the user to check the
                           input.
                           <br />
                           Mobile browsers cannot check PDFs in an iframe, but you can easily achieve