linecraft 0.2.0 → 0.3.0

package/LICENSE

@@ -1,22 +1,29 @@
-MIT License
+FLL
 
 Copyright (c) 2025 Linecraft Contributors
 
-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:
+Fair Labor License (FLL) v1.0
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+1. License Grant
+Subject to the conditions outlined in this license, the author(s) grant permission to any individual or company to use, reproduce, and modify this software free of charge.
 
-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.
+2. Eligibility Criteria
+This license is available free of charge under the following conditions:
 
+a. Individuals:
+The individual’s total net worth must be under $1 million USD at the time of use.
+
+b. Companies:
+The CEO’s total annual compensation must be less than fifteen (15) times the total annual compensation of the company’s median employee.
+
+3. License Purchase Requirement
+If an individual or company does not meet the eligibility criteria specified in Section 2, they must obtain a paid license from the author(s) or an authorized distributor before using, reproducing, or modifying this software.
+
+4. Compliance
+The licensee is responsible for ensuring compliance with the eligibility criteria. Misrepresentation of eligibility will result in the immediate termination of the rights granted under this license.
+
+5. No Warranty
+This 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.
+
+6. Limitation of Liability
+In no event shall the author(s) 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

@@ -41,6 +41,30 @@ r.set(
 r.destroy(true);
 ```
 
+## Performance
+
+Linecraft is built for high-performance terminal rendering from Node.js. The renderer includes several optimizations to minimize terminal updates and CPU usage:
+
+### Frame Diffing
+Only updates lines that actually changed. Unchanged lines are skipped entirely, reducing terminal writes by up to 90% for static content.
+
+### Render Throttling
+Uses high-resolution timing (`process.hrtime.bigint()`) to limit frame rate (default: 30 FPS). Prevents excessive rendering during rapid updates while maintaining smooth animations.
+
+### Batched ANSI Operations
+All ANSI escape sequences are batched into a single `stdout.write()` call per frame, minimizing syscalls and improving throughput.
+
+### Efficient Cursor Movement
+Optimized ANSI cursor positioning that only moves when necessary. The renderer tracks viewport state to avoid redundant cursor movements.
+
+### Viewport Management
+Only renders visible lines within the terminal viewport. Content that extends beyond the viewport is efficiently managed without unnecessary rendering.
+
+### Auto-Wrap Disabled
+Disables terminal auto-wrap to prevent unwanted line breaks, ensuring precise control over terminal output layout.
+
+These optimizations make Linecraft suitable for real-time terminal UIs, progress displays, and animated components without overwhelming the terminal or consuming excessive CPU.
+
 ## Core API
 
 ### Region
@@ -103,7 +127,7 @@ r.set(Styled({
 
 Wrap content in a bordered box with an optional title.
 
-![Section Example](docs/examples/section.gif)
+![Section Example](https://raw.githubusercontent.com/matthew-dean/linecraft/main/docs/examples/section.gif)
 
 ```typescript
 import { Section } from 'linecraft';
@@ -128,7 +152,7 @@ r.set(Section(
 
 Display code errors and warnings with line numbers, context, and clickable file paths.
 
-![CodeDebug Example](docs/examples/code-debug.gif)
+![CodeDebug Example](https://raw.githubusercontent.com/matthew-dean/linecraft/main/docs/examples/code-debug.gif)
 
 ```typescript
 import { CodeDebug } from 'linecraft';
@@ -161,7 +185,7 @@ r.set(CodeDebug({
 
 Animated spinners for loading states. Includes built-in styles or use custom frames.
 
-![Spinner Example](docs/examples/spinner.gif)
+![Spinner Example](https://raw.githubusercontent.com/matthew-dean/linecraft/main/docs/examples/spinner.gif)
 
 ```typescript
 import { Spinner } from 'linecraft';
@@ -194,7 +218,7 @@ Spinners automatically stop when components are replaced or the region is destro
 
 Progress bars with customizable colors and styling.
 
-![ProgressBar Example](docs/examples/progressbar.gif)
+![ProgressBar Example](https://raw.githubusercontent.com/matthew-dean/linecraft/main/docs/examples/progressbar.gif)
 
 ```typescript
 import { progressBar } from 'linecraft';
@@ -219,7 +243,7 @@ r.set(progressBar({
 
 Create segmented displays (like oh-my-zsh style prompts).
 
-![Segments Example](docs/examples/segments.gif)
+![Segments Example](https://raw.githubusercontent.com/matthew-dean/linecraft/main/docs/examples/segments.gif)
 
 ```typescript
 import { Segments } from 'linecraft';
@@ -242,7 +266,7 @@ r.set(Segments({
 
 Create responsive grid layouts. Children automatically wrap to new rows when they exceed the number of explicit columns.
 
-![Grid Example](docs/examples/grid.gif)
+![Grid Example](https://raw.githubusercontent.com/matthew-dean/linecraft/main/docs/examples/grid.gif)
 
 ```typescript
 import { Grid } from 'linecraft';
@@ -285,7 +309,7 @@ r.set(Grid({
 
 Fill available space with a character. Typically used within grids.
 
-![Fill Example](docs/examples/fill.gif)
+![Fill Example](https://raw.githubusercontent.com/matthew-dean/linecraft/main/docs/examples/fill.gif)
 
 ```typescript
 import { fill } from 'linecraft';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "linecraft",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "High-performance terminal UI library for Node.js",
   "type": "module",
   "main": "./lib/index.js",
@@ -18,7 +18,11 @@
   "files": [
     "lib/**/*"
   ],
-  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/matthew-dean/linecraft.git"
+  },
+  "license": "FLL",
   "keywords": [
     "terminal",
     "tui",