Skip to content

Commit 555dc0a

Browse files
committed
Add README.md
1 parent 18382b1 commit 555dc0a

File tree

2 files changed

+166
-0
lines changed

2 files changed

+166
-0
lines changed

en/README.md

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Tinystruct Framework
2+
3+
`"How many are your works, O LORD! In wisdom you made them all; the earth is full of your creatures."`
4+
***Psalms 104:24***
5+
6+
## Overview
7+
8+
Tinystruct is a simple yet powerful framework for Java development. It embraces simple thinking and better design principles, making it easy to use while delivering excellent performance.
9+
10+
## Key Features
11+
12+
- **Lightweight Architecture**: Minimal overhead with maximum flexibility
13+
- **Dual-Mode Support**: Build both web applications and CLI tools
14+
- **Simple Configuration**: Easy to set up and customize
15+
- **High Performance**: Optimized for efficient execution
16+
- **Database Integration**: Built-in support for multiple databases
17+
- **RESTful Support**: Easy API development
18+
- **Command Line Tools**: Powerful CLI capabilities
19+
20+
## Quick Start
21+
22+
### Maven Integration
23+
24+
Add the dependency to your pom.xml:
25+
26+
```xml
27+
<dependency>
28+
<groupId>org.tinystruct</groupId>
29+
<artifactId>tinystruct</artifactId>
30+
<version>1.6.3</version>
31+
<classifier>jar-with-dependencies</classifier>
32+
</dependency>
33+
```
34+
35+
### Basic Application Example
36+
37+
```java
38+
package tinystruct.examples;
39+
40+
import org.tinystruct.AbstractApplication;
41+
import org.tinystruct.ApplicationException;
42+
import org.tinystruct.system.annotation.Action;
43+
44+
public class Example extends AbstractApplication {
45+
46+
@Override
47+
public void init() {
48+
// Initialization code
49+
}
50+
51+
@Action("praise")
52+
public String praise() {
53+
return "Praise the Lord!";
54+
}
55+
56+
@Action("say")
57+
public String say(String words) {
58+
return words;
59+
}
60+
}
61+
```
62+
63+
## Documentation Contents
64+
65+
- [Getting Started](getting-started.md)
66+
- [Core Concepts](core-concepts.md)
67+
- [Web Applications](web-applications.md)
68+
- [CLI Applications](cli-applications.md)
69+
- [Configuration](configuration.md)
70+
- [Database Integration](database.md)
71+
- [Advanced Features](advanced-features.md)
72+
- [Best Practices](best-practices.md)
73+
- [API Reference](api/README.md)
74+
75+
## Community and Support
76+
77+
- GitHub Repository: [https://github.com/tinystruct/tinystruct](https://github.com/tinystruct/tinystruct)
78+
- Issue Tracker: [https://github.com/tinystruct/tinystruct/issues](https://github.com/tinystruct/tinystruct/issues)
79+
- Discussion Forum: [https://github.com/tinystruct/tinystruct/discussions](https://github.com/tinystruct/tinystruct/discussions)
80+
81+
## License
82+
83+
Licensed under the Apache License, Version 2.0

zh/README.md

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
# Tinystruct 框架
2+
3+
`"耶和华啊,你所造的何其多!都是你用智慧造成的;遍地满了你的丰富。"`
4+
***诗篇 104:24***
5+
6+
## 概述
7+
8+
Tinystruct 是一个简单而强大的 Java 开发框架。它秉承简单思维和更好的设计原则,易于使用的同时提供卓越的性能。
9+
10+
## 主要特性
11+
12+
- **轻量级架构**:最小的开销,最大的灵活性
13+
- **双模式支持**:同时支持 Web 应用和命令行工具开发
14+
- **简单配置**:易于设置和自定义
15+
- **高性能**:优化的执行效率
16+
- **数据库集成**:内置多数据库支持
17+
- **RESTful 支持**:便捷的 API 开发
18+
- **命令行工具**:强大的 CLI 功能
19+
20+
## 快速开始
21+
22+
### Maven 集成
23+
24+
在 pom.xml 中添加依赖:
25+
26+
```xml
27+
<dependency>
28+
<groupId>org.tinystruct</groupId>
29+
<artifactId>tinystruct</artifactId>
30+
<version>1.6.3</version>
31+
<classifier>jar-with-dependencies</classifier>
32+
</dependency>
33+
```
34+
35+
### 基础应用示例
36+
37+
```java
38+
package tinystruct.examples;
39+
40+
import org.tinystruct.AbstractApplication;
41+
import org.tinystruct.ApplicationException;
42+
import org.tinystruct.system.annotation.Action;
43+
44+
public class Example extends AbstractApplication {
45+
46+
@Override
47+
public void init() {
48+
// 初始化代码
49+
}
50+
51+
@Action("praise")
52+
public String praise() {
53+
return "赞美主!";
54+
}
55+
56+
@Action("say")
57+
public String say(String words) {
58+
return words;
59+
}
60+
}
61+
```
62+
63+
## 文档目录
64+
65+
- [入门指南](getting-started.md)
66+
- [核心概念](core-concepts.md)
67+
- [Web应用开发](web-applications.md)
68+
- [命令行应用](cli-applications.md)
69+
- [配置说明](configuration.md)
70+
- [数据库集成](database.md)
71+
- [高级特性](advanced-features.md)
72+
- [最佳实践](best-practices.md)
73+
- [API 参考](api/README.md)
74+
75+
## 社区与支持
76+
77+
- GitHub 仓库:[https://github.com/tinystruct/tinystruct](https://github.com/tinystruct/tinystruct)
78+
- 问题追踪:[https://github.com/tinystruct/tinystruct/issues](https://github.com/tinystruct/tinystruct/issues)
79+
- 讨论论坛:[https://github.com/tinystruct/tinystruct/discussions](https://github.com/tinystruct/tinystruct/discussions)
80+
81+
## 许可证
82+
83+
基于 Apache License 2.0 授权

0 commit comments

Comments
 (0)