tenara-ui-components 0.1.0 → 0.1.1

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.
Files changed (2) hide show
  1. package/README.md +58 -21
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -1,36 +1,73 @@
1
- This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
1
+ # Tenara UI Components
2
2
 
3
- ## Getting Started
3
+ A React component library built with atomic design principles, featuring reusable UI components for modern web applications.
4
4
 
5
- First, run the development server:
5
+ ## Installation
6
6
 
7
7
  ```bash
8
- npm run dev
9
- # or
10
- yarn dev
11
- # or
12
- pnpm dev
13
- # or
14
- bun dev
8
+ npm install tenara-ui-components
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ ```jsx
14
+ import { Button, Header } from 'tenara-ui-components';
15
+
16
+ function App() {
17
+ return (
18
+ <div>
19
+ <Header
20
+ onLogin={() => console.log('Login')}
21
+ onCreateAccount={() => console.log('Sign up')}
22
+ />
23
+ <Button label="Click me" primary />
24
+ </div>
25
+ );
26
+ }
15
27
  ```
16
28
 
17
- Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
29
+ ## Components
18
30
 
19
- You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
31
+ ### Atoms
32
+ - **Button** - Primary UI component for user interaction
20
33
 
21
- This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
34
+ ### Molecules
35
+ - **Header** - Navigation header with user authentication
22
36
 
23
- ## Learn More
37
+ ### Pages
38
+ - **Page** - Complete page layout example
39
+
40
+ ## Development
41
+
42
+ ### Install dependencies
43
+ ```bash
44
+ npm install
45
+ ```
24
46
 
25
- To learn more about Next.js, take a look at the following resources:
47
+ ### Run development server
48
+ ```bash
49
+ npm run dev
50
+ ```
26
51
 
27
- - [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28
- - [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
52
+ ### Run Storybook
53
+ ```bash
54
+ npm run storybook
55
+ ```
29
56
 
30
- You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
57
+ ### Build library
58
+ ```bash
59
+ npm run build:lib
60
+ ```
31
61
 
32
- ## Deploy on Vercel
62
+ ### Publish to npm
63
+ ```bash
64
+ npm publish --access public
65
+ ```
33
66
 
34
- The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
67
+ ## Built With
35
68
 
36
- Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
69
+ - React 19
70
+ - Next.js 15
71
+ - TypeScript
72
+ - Storybook
73
+ - Rollup
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tenara-ui-components",
3
- "version": "0.1.0",
3
+ "version": "0.1.1",
4
4
  "type": "module",
5
5
  "private": false,
6
6
  "main": "dist/index.js",