@vishu1301/script-writing 0.1.1 → 0.1.2
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 +14 -11
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,18 +1,21 @@
|
|
|
1
|
-
|
|
1
|
+
# Script Writing Editor
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A modern, React-based script and screenplay writing component for the web.
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
This component provides writers with an intuitive and distraction-free environment to draft, edit, and format their scripts seamlessly within any React or Next.js application.
|
|
6
|
+
|
|
7
|
+
## Features
|
|
8
|
+
|
|
9
|
+
- **Distraction-Free Editor:** Focus on your story without cluttered UI.
|
|
10
|
+
- **Auto-Formatting:** Automatically formats text to industry-standard screenplay guidelines (e.g., Scene Headings, Action, Character, Dialogue).
|
|
11
|
+
- **Headless Logic:** Core editor logic (`useScreenplayEditor` hook) is separated from the view for customizability.
|
|
12
|
+
- **Responsive Design:** Write on the go, works across desktop and mobile devices.
|
|
13
|
+
- **Event-Driven:** Provides callbacks to handle saving, exporting to PDF, or syncing with the cloud.
|
|
14
|
+
|
|
15
|
+
## Installation
|
|
6
16
|
|
|
7
17
|
```bash
|
|
8
|
-
npm
|
|
9
|
-
# or
|
|
10
|
-
yarn dev
|
|
11
|
-
# or
|
|
12
|
-
pnpm dev
|
|
13
|
-
# or
|
|
14
|
-
bun dev
|
|
15
|
-
```
|
|
18
|
+
npm install @vishu1301/script-writing
|
|
16
19
|
|
|
17
20
|
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
|
18
21
|
|