react-3d-flipbook 1.1.11 → 1.1.12
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,7 +1,12 @@
|
|
|
1
1
|
# React 3D Flipbook
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/react-3d-flipbook)
|
|
4
|
+
[](https://opensource.org/licenses/MIT)
|
|
5
|
+
|
|
3
6
|
A modern, feature-rich React library for creating beautiful, interactive 3D flipbooks with realistic page-turning effects powered by WebGL and Three.js.
|
|
4
7
|
|
|
8
|
+
📚 **[Live Demo & Documentation (Storybook)](https://hdn-james.github.io/react-flipbook/)**
|
|
9
|
+
|
|
5
10
|
---
|
|
6
11
|
|
|
7
12
|
## Features
|
|
@@ -971,14 +976,18 @@ import type {
|
|
|
971
976
|
|
|
972
977
|
## Contributing
|
|
973
978
|
|
|
974
|
-
Contributions are welcome! Please
|
|
979
|
+
Contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for details on our development workflow, commit conventions, and release process.
|
|
980
|
+
|
|
981
|
+
### Quick Start
|
|
975
982
|
|
|
976
983
|
1. Fork the repository
|
|
977
|
-
2. Create a feature branch: `git checkout -b
|
|
978
|
-
3. Commit changes: `git commit -
|
|
979
|
-
4. Push to branch: `git push origin
|
|
984
|
+
2. Create a feature branch: `git checkout -b feat/my-feature`
|
|
985
|
+
3. Commit changes following [Conventional Commits](https://www.conventionalcommits.org/): `git commit -m 'feat: add new feature'`
|
|
986
|
+
4. Push to branch: `git push origin feat/my-feature`
|
|
980
987
|
5. Submit a Pull Request
|
|
981
988
|
|
|
989
|
+
See the [Contributing Guide](CONTRIBUTING.md) for more details on GitHub Actions workflows and the automated release process.
|
|
990
|
+
|
|
982
991
|
---
|
|
983
992
|
|
|
984
993
|
## License
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "react-3d-flipbook",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.12",
|
|
4
4
|
"description": "A modern React library for creating beautiful, interactive 3D flipbooks with realistic page-turning effects powered by WebGL and Three.js. Supports PDF loading, automatic page sizing, and customizable camera controls.",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"module": "dist/index.esm.js",
|