@cli-use/tui 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 cli-use 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:
+
+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

@@ -0,0 +1,125 @@
+# cli-use
+
+> Build beautiful terminal user interfaces with Ink
+
+A powerful TUI (Terminal User Interface) framework using **Ink** (React for CLIs). Create stunning terminal interfaces with tables, lists, markdown rendering, custom styles, and flex-like layouts.
+
+## 🎯 Overview
+
+`cli-use` lets you build beautiful terminal applications using **Ink** - the most popular React-based TUI framework. Create tables, lists, markdown rendering, custom styles, and flex-like layouts - all with React components you already know.
+
+## ✨ Features
+
+- **🎨 Beautiful Styling** - CSS-like properties for stunning interfaces
+- **📊 Tables** - Render beautiful tables with borders, colors, and alignment
+- **📝 Lists** - Create interactive lists with selection states and custom enumerators
+- **📖 Markdown** - Render markdown with themes
+- **📐 Layouts** - Flex-like horizontal/vertical layouts
+- **🔧 TypeScript** - Full type safety and excellent IDE support
+- **⚡ Cross-Platform** - Works on macOS, Linux, and Windows
+
+## 🚀 Quick Start
+
+```bash
+# Install
+npm install cli-use
+
+# Run the demo
+npm run example:ink-demo
+```
+
+## 💡 Examples
+
+### Basic App
+
+```tsx
+import React from 'react';
+import { render, Box, Text } from 'ink';
+
+const App = () => (
+  <Box borderStyle="round" padding={1}>
+    <Text bold>Hello from cli-use!</Text>
+  </Box>
+);
+
+render(<App />);
+```
+
+### Interactive Counter
+
+```tsx
+import React, { useState } from 'react';
+import { render, Box, Text, useInput } from 'ink';
+
+const Counter = () => {
+  const [count, setCount] = useState(0);
+
+  useInput((input, key) => {
+    if (key.return) setCount(c => c + 1);
+  });
+
+  return (
+    <Box>
+      <Text>Count: {count}</Text>
+      <Text dim>Press Enter to increment</Text>
+    </Box>
+  );
+};
+
+render(<Counter />);
+```
+
+## 📦 API
+
+### Core Components
+
+- **`Box`** - Container component for layout and styling
+- **`Text`** - Text rendering with colors and styles
+- **`render()`** - Render Ink apps to terminal
+- **`useInput()`** - Handle keyboard input
+- **`useApp()`** - App instance management
+
+## 🧰 Development
+
+```bash
+# Install dependencies
+npm install
+
+# Build
+npm run build
+
+# Run tests
+npm run test:unit
+
+# Type check
+npm run typecheck
+
+# Run demo
+npm run example:ink-demo
+```
+
+## 📁 Project Structure
+
+```
+cli-use/
+├── src/
+│   ├── renderer/
+│   │   └── terminal.ts          # Terminal handling
+│   └── examples/
+│   │   └── ink-demo.tsx        # Interactive demo
+├── package.json
+├── tsconfig.json
+└── README.md
+```
+
+## 🤝 Contributing
+
+Contributions welcome! Please read our contributing guidelines before submitting PRs.
+
+## 📄 License
+
+MIT © 2025 cli-use contributors
+
+---
+
+**Built with ❤️ and Ink**