forstok-ui-lib 1.0.0 → 1.0.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.
- package/README.md +47 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# Forstok UI Library
|
|
2
|
+
|
|
3
|
+
Collection for reusable Forstok UI Components and libraries.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- TextComponent
|
|
8
|
+
|
|
9
|
+
## Installation
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install forstok-ui-lib
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
```tsx
|
|
18
|
+
import { TextComponent } from 'forstok-ui-lib';
|
|
19
|
+
|
|
20
|
+
<TextComponent />
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Configuration
|
|
24
|
+
|
|
25
|
+
Explain any configuration options if applicable.
|
|
26
|
+
|
|
27
|
+
## API Reference
|
|
28
|
+
|
|
29
|
+
Document your API endpoints or main functions if applicable.
|
|
30
|
+
|
|
31
|
+
## Contributing
|
|
32
|
+
|
|
33
|
+
Instructions for how others can contribute to your project.
|
|
34
|
+
|
|
35
|
+
1. Fork the repository
|
|
36
|
+
2. Create a new branch
|
|
37
|
+
3. Make your changes
|
|
38
|
+
4. Submit a pull request
|
|
39
|
+
|
|
40
|
+
## License
|
|
41
|
+
|
|
42
|
+
This project is licensed under the [LICENSE NAME] - see the [LICENSE.md](LICENSE.md) file for details.
|
|
43
|
+
|
|
44
|
+
## Acknowledgments
|
|
45
|
+
|
|
46
|
+
- Credit any inspirations, code snippets, etc.
|
|
47
|
+
- Hat tip to anyone whose code was used
|