Skip to content

Commit

Permalink
docs update, change version 1.0.2 to 1.0.3
Browse files Browse the repository at this point in the history
  • Loading branch information
tomsun28 committed Apr 29, 2021
1 parent 34aabe2 commit 3b8ba9a
Show file tree
Hide file tree
Showing 14 changed files with 861 additions and 17 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Ever since sureness was born, we hope to solve these, provide a **REST API**, **

> [Sureness](https://github.com/usthe/sureness) is a simple and efficient open-source security framework that focus on the protection of REST API.
> Provide authentication and authorization, based on RBAC.
> No specific framework dependency (supports Javalin, Spring Boot, Quarkus, Ktor, and more).
> No specific framework dependency (supports Javalin, Spring Boot, Quarkus, Ktor, Micronaut and more).
> Supports dynamic modification of permissions.
> Supports WebSockets and mainstream HTTP containers (Servlet and JAX-RS).
> Supports JWT, Basic Auth, Digest Auth, and can be extended to support custom authentication methods.
Expand Down Expand Up @@ -71,7 +71,8 @@ Detail see [Benchmark Test](https://github.com/tomsun28/sureness-shiro-spring-se
- [x] sureness integration quarkus sample [sample-quarkus](samples/quarkus-sureness)
- [x] sureness integration javalin sample [sample-javalin](samples/javalin-sureness)
- [x] sureness integration ktor sample [sample-ktor](samples/ktor-sureness)
- [x] sureness integration spring webflux sample [sample-spring-webflux](samples/spring-webflux-sureness)
- [x] sureness integration spring webflux sample [sample-spring-webflux](samples/spring-webflux-sureness)
- [x] sureness integration micronaut sample [sample-micronaut](samples/micronaut-sureness)
- [x] sureness integration session sample [sureness-session](samples/sureness-session)
- [x] sureness integration redis cache session sample [sureness-redis-session](samples/sureness-redis-session)
- [x] more samples todo
Expand All @@ -95,11 +96,11 @@ When use maven or gradle build project, add coordinate
<dependency>
<groupId>com.usthe.sureness</groupId>
<artifactId>sureness-core</artifactId>
<version>1.0.2</version>
<version>1.0.3</version>
</dependency>
```
```
compile group: 'com.usthe.sureness', name: 'sureness-core', version: '1.0.2'
compile group: 'com.usthe.sureness', name: 'sureness-core', version: '1.0.3'
```

#### 🐵 Use the Default Configuration to Configure Sureness
Expand Down
7 changes: 4 additions & 3 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@

> `sureness` 是我们在深度使用权限框架 `apache shiro` 之后,吸取其优点全新设计开发的一个认证鉴权框架
> 面向 `REST API` 的认证鉴权,基于 `RBAC` (用户-角色-资源)主要关注于对 `API` 的安全保护
> 无特定框架依赖(本质就是过滤器处拦截判断,已有 `Springboot,Quarkus,Javalin,Ktor` 等集成样例)
> 无特定框架依赖(本质就是过滤器处拦截判断,已有 `Springboot,Quarkus,Javalin,Ktor,Micronaut` 等集成样例)
> 支持动态修改权限配置(动态修改配置每个 `API` 谁有权访问)
> 支持 `Websocket` ,主流 `HTTP` 容器 `Servlet``JAX-RS`
> 支持多种认证策略, `JWT, Basic auth, Digest auth` ... 可扩展自定义支持的认证方式
Expand Down Expand Up @@ -72,6 +72,7 @@
- [x] sureness集成javalin样例 [sample-javalin](samples/javalin-sureness)
- [x] sureness集成ktor样例 [sample-ktor](samples/ktor-sureness)
- [x] sureness集成spring webflux样例 [sample-spring-webflux](samples/spring-webflux-sureness)
- [x] sureness集成micronaut样例 [sample-micronaut](samples/micronaut-sureness)
- [x] sureness使用session样例 [sureness-session](samples/sureness-session)
- [x] sureness分布式缓存session样例 [sureness-redis-session](samples/sureness-redis-session)
- [x] more samples todo
Expand All @@ -95,11 +96,11 @@
<dependency>
<groupId>com.usthe.sureness</groupId>
<artifactId>sureness-core</artifactId>
<version>1.0.2</version>
<version>1.0.3</version>
</dependency>
```
```
compile group: 'com.usthe.sureness', name: 'sureness-core', version: '1.0.2'
compile group: 'com.usthe.sureness', name: 'sureness-core', version: '1.0.3'
```

#### 🐵 使用默认配置来配置sureness
Expand Down
2 changes: 1 addition & 1 deletion core/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<modelVersion>4.0.0</modelVersion>
<groupId>com.usthe.sureness</groupId>
<artifactId>sureness-core</artifactId>
<version>1.0.2</version>
<version>1.0.3</version>
<packaging>jar</packaging>

<name>sureness</name>
Expand Down
3 changes: 2 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
> A simple and efficient open-source jvm security framework that focus on the protection of restful api.
[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
[![Maven](https://img.shields.io/badge/Maven%20Central-1.0.2-blue.svg)](https://search.maven.org/artifact/com.usthe.sureness/sureness-core)
[![Maven](https://img.shields.io/badge/Maven%20Central-1.0.3-blue.svg)](https://search.maven.org/artifact/com.usthe.sureness/sureness-core)
![GitHub pull request check contexts](https://img.shields.io/github/status/contexts/pulls/tomsun28/sureness/8?label=pull%20checks)
[![Gitter](https://img.shields.io/gitter/room/usthe/sureness?label=sureness&color=orange&logo=gitter&logoColor=red)](https://gitter.im/usthe/sureness)
![GitHub Release Date](https://img.shields.io/github/release-date/tomsun28/sureness?color=blue&logo=figshare&logoColor=red)
Expand Down Expand Up @@ -66,6 +66,7 @@ Detail see [Benchmark Test](https://github.com/tomsun28/sureness-shiro-spring-se
- [x] sureness integration javalin sample [sample-javalin](sample-javalin.md)
- [x] sureness integration ktor sample [sample-ktor](sample-ktor.md)
- [x] sureness integration spring webflux sample [spring-webflux-sureness](sample-spring-webflux.md)
- [x] sureness integration micronaut sample [sample-micronaut](sample-micronaut.md)
- [x] sureness integration session sample [sureness-session](https://github.com/usthe/sureness/tree/master/samples/sureness-session)
- [x] sureness integration redis cache session sample [sureness-redis-session](https://github.com/usthe/sureness/tree/master/samples/sureness-redis-session)
- [x] more samples todo
2 changes: 1 addition & 1 deletion docs/_coverpage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
![logo](_media/icon128.svg)

# sureness <small>1.0.2 for jvm</small>
# sureness <small>1.0.3 for jvm</small>

> Focusing on Protection of REST API.
Expand Down
1 change: 1 addition & 0 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
- [Spring-Webflux-Sureness Sample](sample-spring-webflux.md)
- [Javalin-Sureness Sample](sample-javalin.md)
- [Ktor-Sureness Sample](sample-ktor.md)
- [Micronaut-Sureness Sample](sample-micronaut.md)

- Others
- [Design](design.md)
Expand Down
3 changes: 2 additions & 1 deletion docs/cn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
> 面向`REST API`的高性能认证鉴权框架
[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
[![Maven](https://img.shields.io/badge/Maven%20Central-1.0.2-blue.svg)](https://search.maven.org/artifact/com.usthe.sureness/sureness-core)
[![Maven](https://img.shields.io/badge/Maven%20Central-1.0.3-blue.svg)](https://search.maven.org/artifact/com.usthe.sureness/sureness-core)
![GitHub pull request check contexts](https://img.shields.io/github/status/contexts/pulls/tomsun28/sureness/8?label=pull%20checks)
[![Gitter](https://img.shields.io/gitter/room/usthe/sureness?label=sureness&color=orange&logo=gitter&logoColor=red)](https://gitter.im/usthe/sureness)
![GitHub Release Date](https://img.shields.io/github/release-date/tomsun28/sureness?color=blue&logo=figshare&logoColor=red)
Expand Down Expand Up @@ -67,6 +67,7 @@
- [x] sureness集成javalin样例 [sample-javalin](cn/sample-javalin.md)
- [x] sureness集成ktor样例 [sample-ktor](cn/sample-ktor.md)
- [x] sureness集成spring webflux样例 [spring-webflux-sureness](cn/sample-spring-webflux.md)
- [x] sureness集成micronaut样例 [sample-micronaut](cn/sample-micronaut.md)
- [x] sureness使用session样例 [sureness-session](https://github.com/usthe/sureness/tree/master/samples/sureness-session)
- [x] sureness分布式缓存session样例 [sureness-redis-session](https://github.com/usthe/sureness/tree/master/samples/sureness-redis-session)
- [x] more samples todo
2 changes: 1 addition & 1 deletion docs/cn/_coverpage.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
![logo](../_media/icon128.svg)

# sureness <small>1.0.2 for jvm</small>
# sureness <small>1.0.3 for jvm</small>

> 面向`REST API`的高性能认证鉴权框架
Expand Down
1 change: 1 addition & 0 deletions docs/cn/_sidebar.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
- [Spring-Webflux项目集成](cn/sample-spring-webflux.md)
- [Javalin项目集成](cn/sample-javalin.md)
- [Ktor项目集成](cn/sample-ktor.md)
- [Micronaut项目集成](cn/sample-micronaut.md)

- 其它
- [设计文档](cn/design.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/cn/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@
<dependency>
<groupId>com.usthe.sureness</groupId>
<artifactId>sureness-core</artifactId>
<version>1.0.2</version>
<version>1.0.3</version>
</dependency>
```
```
compile group: 'com.usthe.sureness', name: 'sureness-core', version: '1.0.2'
compile group: 'com.usthe.sureness', name: 'sureness-core', version: '1.0.3'
```

#### 🐵 使用默认配置来配置sureness
Expand Down

0 comments on commit 3b8ba9a

Please sign in to comment.