init

.gitignore

@@ -1,3 +1,4 @@
 node_modules
 dist
 .DS_Store
+.next

README.md

@@ -1,5 +1,35 @@
 # React Wrap Balancer
 
+One simple component to make your titles more elegant:
+
+![](.github/demo.gif)
+
+Notice that in “Balanced Title Wrapping” above, every line of wrapped text has almost the same width, so it will likely not to have one single word in a line.
+
+## Usage
+
+Install it to your React project:
+
+```bash
+npm i react-wrap-balancer
+```
+
+And wrap any text with it:
+
+```jsx
+import { Balancer } from 'react-wrap-balancer'
+
+// ...
+
+function Title() {
+  return (
+    <h1>
+      <Balancer>My Awesome Title</Balancer>
+    </h1>
+  )
+}
+```
+
 ## Requirements
 
 This library uses browser and React 18 APIs such as:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-wrap-balancer",
-  "version": "0.1.0",
+  "version": "0.2.3",
   "description": "Better text wrapping.",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -9,7 +9,7 @@
     "dist"
   ],
   "scripts": {
-    "build": "tsup src/index.tsx --format cjs,esm --dts-resolve --external react"
+    "build": "tsup src/index.tsx"
   },
   "keywords": [
     "react",
@@ -20,6 +20,7 @@
   "author": "Shu Ding <g@shud.in>",
   "license": "MIT",
   "devDependencies": {
+    "@types/node": "^18.11.13",
     "react": "^18.2.0",
     "tsup": "^6.4.0",
     "typescript": "^4.8.4"