@thisiscrowd/crowdbox 1.0.0 → 1.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 thisiscrowd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -16,6 +16,31 @@ A modern, lightweight, extensible JavaScript Crowdbox gallery plugin.
 
 ---
 
+## Installation
+
+### NPM
+
+```bash
+npm install @thisiscrowd/crowdbox
+```
+
+### Yarn
+
+```bash
+yarn add @thisiscrowd/crowdbox
+```
+
+### CDN
+
+```html
+<!-- CSS -->
+<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@thisiscrowd/crowdbox@latest/dist/crowdbox.css">
+
+<!-- JavaScript (UMD) -->
+<script src="https://cdn.jsdelivr.net/npm/@thisiscrowd/crowdbox@latest/dist/crowdbox.umd.js"></script>
+```
+
+---
 
 ## Quick Start — Vanilla JS
 
@@ -51,8 +76,8 @@ A modern, lightweight, extensible JavaScript Crowdbox gallery plugin.
 ### JavaScript API
 
 ```js
-import Crowdbox from 'crowdbox';
-import 'crowdbox/styles';
+import Crowdbox from "@thisiscrowd/crowdbox";
+import '@thisiscrowd/crowdbox/styles';
 
 const gallery = new Crowdbox({ loop: true, thumbnails: true });
 
@@ -157,8 +182,8 @@ gallery.destroy();
 ### GalleryGrid (simplest)
 
 ```jsx
-import { GalleryGrid } from 'crowdbox/react';
-import 'crowdbox/styles';
+import { GalleryGrid } from '@thisiscrowd/crowdbox/react';
+import '@thisiscrowd/crowdbox/styles';
 
 const items = [
   { src: 'photo1.jpg', type: 'image', thumb: 'thumb1.jpg', caption: 'Photo 1' },
@@ -173,7 +198,8 @@ export default function Page() {
 ### Controlled Lightbox component
 
 ```jsx
-import { Lightbox } from 'crowdbox/react';
+import { Lightbox } from '@thisiscrowd/crowdbox/react';
+import '@thisiscrowd/crowdbox/styles';
 
 const [open, setOpen] = useState(false);
 
@@ -189,7 +215,8 @@ const [open, setOpen] = useState(false);
 ### useLightbox hook
 
 ```jsx
-import { useLightbox } from 'crowdbox/react';
+import { useLightbox } from '@thisiscrowd/crowdbox/react';
+import '@thisiscrowd/crowdbox/styles';
 
 function MyGallery({ items }) {
   const { open } = useLightbox({ thumbnails: true, captions: true });
@@ -216,8 +243,8 @@ export default function Gallery({ items }) {
   useEffect(() => {
     let g;
     // Dynamic import keeps Crowdbox out of the server bundle
-    import('crowdbox').then(({ Crowdbox }) => {
-      import('crowdbox/styles');
+    import('@thisiscrowd/crowdbox').then(({ Crowdbox }) => {
+      import('@thisiscrowd/crowdbox/styles');
       g = new Crowdbox({ selector: null, thumbnails: true });
       galleryRef.current = g;
     });
@@ -240,9 +267,12 @@ export default function Gallery({ items }) {
 }
 ```
 
+## Plugins & Adapters
+
+### Custom plugin
 
 ```js
-import { Registry } from 'crowdbox';
+import { Registry } from '@thisiscrowd/crowdbox';
 
 const WatermarkPlugin = {
   pluginName: 'watermark',
@@ -271,7 +301,7 @@ const gallery = new Crowdbox({ watermark: true });
 ### Custom media adapter
 
 ```js
-import { Registry } from 'crowdbox';
+import { Registry } from '@thisiscrowd/crowdbox';
 
 Registry.registerAdapter('soundcloud', {
   type: 'soundcloud',
@@ -346,3 +376,65 @@ All modern browsers (Chrome 80+, Firefox 75+, Safari 13.1+, Edge 80+). Uses:
 - Fullscreen API
 
 ---
+
+## Development
+
+### Build from source
+
+```bash
+# Clone repository
+git clone https://github.com/thisiscrowd/crowdbox.git
+cd crowdbox
+
+# Install dependencies
+npm install
+
+# Build (JS + CSS)
+npm run build:all
+
+# Watch mode (auto-rebuild on changes)
+npm run dev
+```
+
+### Project structure
+
+```
+src/
+├── adapters/      # Media type handlers (image, video, YouTube, etc.)
+├── core/          # Core lightbox logic
+├── plugins/       # Optional features (zoom, thumbnails, share, etc.)
+├── react/         # React components and hooks
+└── styles/        # SCSS source files
+```
+
+---
+
+## Contributing
+
+Contributions welcome! Please:
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+---
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+---
+
+## Links
+
+- **NPM Package**: [npmjs.com/package/@thisiscrowd/crowdbox](https://www.npmjs.com/package/@thisiscrowd/crowdbox)
+- **Repository**: [github.com/thisiscrowd/crowdbox](https://github.com/thisiscrowd/crowdbox)
+- **Issues**: [github.com/thisiscrowd/crowdbox/issues](https://github.com/thisiscrowd/crowdbox/issues)
+
+---
+
+## Acknowledgments
+
+Inspired by Fancybox, Lightbox2, and other gallery libraries, but built from scratch with modern web standards.

package/dist/crowdbox.esm.js

@@ -1,5 +1,5 @@
 /*!
- * Crowdbox v1.0.0
+ * Crowdbox v1.0.2
  * A modern, lightweight, extensible Crowdbox gallery plugin supporting images and video
  * (c) 2026 Crowdbox
  * Released under the MIT License.

package/dist/crowdbox.umd.js

@@ -1,5 +1,5 @@
 /*!
- * Crowdbox v1.0.0
+ * Crowdbox v1.0.2
  * A modern, lightweight, extensible Crowdbox gallery plugin supporting images and video
  * (c) 2026 Crowdbox
  * Released under the MIT License.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thisiscrowd/crowdbox",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "type": "module",
   "description": "A modern, lightweight, extensible Crowdbox gallery plugin supporting images and video",
   "main": "dist/crowdbox.umd.js",
@@ -39,8 +39,16 @@
     "nextjs",
     "react"
   ],
-  "author": "",
+  "author": "thisiscrowd",
   "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thisiscrowd/crowdbox.git"
+  },
+  "homepage": "https://github.com/thisiscrowd/crowdbox#readme",
+  "bugs": {
+    "url": "https://github.com/thisiscrowd/crowdbox/issues"
+  },
   "devDependencies": {
     "@rollup/plugin-node-resolve": "^15.0.0",
     "@rollup/plugin-terser": "^0.4.0",
@@ -53,7 +61,11 @@
     "react-dom": ">=17.0.0"
   },
   "peerDependenciesMeta": {
-    "react": { "optional": true },
-    "react-dom": { "optional": true }
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    }
   }
 }