Skip to content
This repository has been archived by the owner on Aug 1, 2022. It is now read-only.

Commit

Permalink
docs: Modify the introduction of the homepage Readme (#42)
Browse files Browse the repository at this point in the history
* docs: Modify the introduction of the homepage Readme

* Update README.md

* docs: Modify how to contribute documentation

* docs: Ddded a roadmap

* chore: Modify License Statement

* docs: Modify the introduction of the homepage Readme
  • Loading branch information
zhenlei520 authored Apr 20, 2022
1 parent 8b7188d commit 692f774
Show file tree
Hide file tree
Showing 2 changed files with 127 additions and 3 deletions.
64 changes: 63 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,65 @@
[](README.zh-CN.md) | EN

# Masa.BuildingBlocks
Building blocks of the MASA Stack, provides a unified interface standard for MASA Contrib's implementation specifications and process connector.
Building blocks of the MASA Stack, provides a unified interface standard for [MASA Contrib](https://github.com/masastack/MASA.Contrib/blob/main/README.md) implementation specifications and process connector.



## Why choose MASA.BuildingBlocks?
* Supports monolithic architecture and distributed architecture
* Based on the .Net main push technology stack, no magic modification, low learning cost
* Provide a unified interface standard, with the best practices of MASA Contrib, but not limited to [MASA Contrib](https://github.com/masastack/MASA.Contrib/blob/main/README.md) , anyone can implement their own Contrib based on MASA BuildingBlocks, re-customize some features



## Roadmap
* [Release notes](https://github.com/masastack/MASA.BuildingBlocks/releases)
* [Latest roadmap](https://github.com/masastack/MASA.BuildingBlocks/issues/39)



## Features
* AutoComplete: make searching easier
* Configuration: Configuration Center
* CQRS
* DDD
* Dispatcher
* Isolation: Support physical isolation, logical isolation
* MinimalAPI: Supports API classification aggregation similar to Controller
* UoW: unit of work
* Storage: cloud storage



## How to contribute

1. Fork & Clone
2. Create Feature_xxx branch
3. Commit with commit message, like `feat(Isolation): Support physical isolation, logical isolation`
4. Create Pull Request

If you wish to contribute, please [Pull Request](https://github.com/masastack/MASA.BuildingBlocks/pulls), or send us a [Report Bug](https://github.com/masastack/MASA.BuildingBlocks/issues/new) .



## Contributors

Thanks to all the friends who have contributed to this project.

<a href="https://github.com/masastack/MASA.BuildingBlocks/graphs/contributors">
<img src="https://contrib.rocks/image?repo=masastack/MASA.BuildingBlocks" />
</a>



## code of conduct

This project adopts the Code of Conduct as defined by the Contributors Covenant to clarify the expected behavior of our community. For more information see [MASA Stack Community Code of Conduct](https://github.com/masastack/community/blob/main/CODE-OF-CONDUCT.md).



## ☀️ License Statement

[![MASA.BuildingBlocks](https://img.shields.io/badge/License-MIT-blue?style=flat-square)](/LICENSE.txt)

Copyright (c) 2021-present MASA Stack
66 changes: 64 additions & 2 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,65 @@
中 | [EN](README.md)
# Masa.BuildingBlocks
MASA Stack的构建块,提供统一的接口标准,用于MASA Contrib的实现规约和流程衔接。

# MASA.BuildingBlocks
MASA Stack的构建块,提供统一的接口标准,用于[MASA Contrib](https://github.com/masastack/MASA.Contrib/blob/main/README.zh-CN.md)的实现规约和流程衔接。



## 为什么选择MASA.BuildingBlocks?
* 支持单体架构,也支持分布式架构
* 基于.Net主推技术栈,不魔改,学习成本低
* 提供统一的接口标准,有MASA Contrib的最佳实践,但不局限于[MASA Contrib](https://github.com/masastack/MASA.Contrib/blob/main/README.zh-CN.md),任何人都可以基于MASA BuildingBlocks实现自己的Contrib,重新定制某些特性



## 路线图
* [发行说明](https://github.com/masastack/MASA.BuildingBlocks/releases)
* [最新路线图](https://github.com/masastack/MASA.BuildingBlocks/issues/39)



## 特性
* AutoComplete: 使搜索更简单
* Configuration: 配置中心
* CQRS
* DDD
* Dispatcher
* Isolation: 支持物理隔离、逻辑隔离
* MinimalAPI: 支持类似Controller的API分类聚合
* UoW: 工作单元
* Storage: 云存储



## 如何贡献

1. Fork & Clone
2. Create Feature_xxx branch
3. Commit with commit message, like `feat(Isolation): Support physical isolation, logical isolation`
4. Create Pull Request

如果你希望参与贡献,欢迎 [Pull Request](https://github.com/masastack/MASA.BuildingBlocks/pulls),或给我们 [报告 Bug](https://github.com/masastack/MASA.BuildingBlocks/issues/new)



## 贡献者

感谢所有为本项目做出过贡献的朋友。

<a href="https://github.com/masastack/MASA.BuildingBlocks/graphs/contributors">
<img src="https://contrib.rocks/image?repo=masastack/MASA.BuildingBlocks" />
</a>



## 行为准则

本项目采用了《贡献者公约》所定义的行为准则,以明确我们社区的预期行为。更多信息请见 [MASA Stack Community Code of Conduct](https://github.com/masastack/community/blob/main/CODE-OF-CONDUCT.md).



## ☀️ 许可声明

[![MASA.BuildingBlocks](https://img.shields.io/badge/License-MIT-blue?style=flat-square)](/LICENSE.txt)

Copyright (c) 2021-present MASA Stack

0 comments on commit 692f774

Please sign in to comment.