Skip to content

Commit bf8b451

Browse files
committed
Revert "Update README.md"
This reverts commit 1f2a62a.
1 parent 1a5029e commit bf8b451

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

README.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,55 @@ WebViewer UI sits on top of [WebViewer](https://pdftron.com/webviewer), a powerf
55
![WebViewer UI](./assets/webviewer-ui.png)
66

77
This repo is specifically designed for any users interested in advanced customizations. With the source code access, it gives developers full control to customize & style the UI, build custom controls & logic, integrate into workflows, or build a UI from scratch.
8+
9+
## Initial setup
10+
11+
To work with this repo, you must download the latest WebViewer and link it to this repo.
12+
13+
1. Download [WebViewer](https://pdftron.com/webviewer).
14+
2. Follow steps from [forking WebViewer](https://pdftron.com/documentation/web/guides/advanced-customization/forking-and-setting-up-the-sync).
15+
16+
Now you can navigate to `WebViewer/lib/ui` and run the commands to install, run and build.
17+
18+
## Install
19+
20+
```
21+
npm install
22+
```
23+
24+
## Run
25+
26+
```
27+
npm start
28+
```
29+
30+
## Build
31+
32+
```
33+
npm run build
34+
```
35+
36+
## Project structure
37+
38+
```
39+
src/
40+
apis/ - APIs exposed in myWebViewer.getInstance()
41+
components/ - React components
42+
constants/ - JavaScript or CSS constants
43+
core/ - APIs from the Core
44+
event-listeners/ - Listeners for the Core events
45+
helpers/ - Reused functions
46+
redux/ - Redux files for state managing
47+
```
48+
49+
## API documentation
50+
51+
See [API documentation](https://pdftron.com/documentation/web/guides/ui/apis).
52+
53+
## Contributing
54+
55+
See [contributing](./CONTRIBUTING.md).
56+
57+
## License
58+
59+
See [license](./LICENSE).

0 commit comments

Comments
 (0)