readme

Author: sgong-pdftron

CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# Contributing to PDFTron - React and React Native sample
+
+## Issues
+1. Check existing issues (open/closed) to avoid duplicates.
+2. Be clear about what the problem is.
+3. Make sure to paste error output or logs.
+4. Code snapshot or demos on online code editor will be very helpful.
+
+## Pull requests
+1. Fork the repository.
+2. Create a branch from `master`.
+3. Update the source code using style guides described below.
+4. Lint your code with `npm run lint`.
+5. Commit and push the changes with descriptive messages.
+6. Create a pull request to `master`.
+
+\* Please note that all pull requests should be tied to an issue, and all but the most trivial pull requests should be discussed before hand.
+
+## Style guides
+- Tab indentation (size of 2 spaces).
+- `'` instead of `"`.
+- Curly braces for block statements.
+- 1TBS brace style.
+- Semicolon at the end of each statement.
+- Object shorthand for ES6.
+- Parenthesis around arrow function argument.
+- Minimum line breaks.
+- No `use strict`.

LICENSE

@@ -0,0 +1,2 @@
+Copyright 2020 PDFTron Systems Inc. All rights reserved.
+PDFTron React and React Native sample or any derived works is only permitted in solutions with an active commercial PDFTron SDK license. For exact licensing terms please refer to your commercial PDFTron license. For use in other scenario, please contact [email protected]

README.md

@@ -19,7 +19,7 @@ npm run web
 
 ### iOS
 
-1. Install pop 
+1. Install dependencies
 
 ```
 cd ios
@@ -46,4 +46,19 @@ sdk.dir=/Users/pdftron/Library/Android/sdk
 
 ```
 npm run android
-```
+```
+
+## Guides
+
+- https://www.pdftron.com/documentation/web
+- https://www.pdftron.com/documentation/ios
+- https://www.pdftron.com/documentation/android
+
+## Contributing
+
+See [contributing](./CONTRIBUTING.md).
+
+## License
+
+See [license](./LICENSE).
+![](https://onepixel.pdftron.com/pdftron-react-and-react-native-sample)