Skip to content

Commit 2b268d3

Browse files
committed
Add Japanese README and enhance English README details
Introduced a new README in Japanese to provide localized documentation. Updated the English README to include improved descriptions of key features and streamlined content for better clarity.
1 parent 85688a0 commit 2b268d3

2 files changed

Lines changed: 33 additions & 7 deletions

File tree

README.ja.md.php

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# BEAR.QueryRepository
2+
3+
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/bearsunday/BEAR.QueryRepository/badges/quality-score.png?b=1.x)](https://scrutinizer-ci.com/g/bearsunday/BEAR.QueryRepository/?branch=1.x)
4+
[![codecov](https://codecov.io/gh/bearsunday/BEAR.QueryRepository/branch/1.x/graph/badge.svg?token=eh3c9AF4Mr)](https://codecov.io/gh/koriym/BEAR.QueryRepository)
5+
[![Type Coverage](https://shepherd.dev/github/bearsunday/BEAR.QueryRepository/coverage.svg)](https://shepherd.dev/github/bearsunday/BEAR.QueryRepository)
6+
[![Coding Standards](https://github.com/bearsunday/BEAR.QueryRepository/actions/workflows/coding-standards.yml/badge.svg)](https://github.com/bearsunday/BEAR.QueryRepository/actions/workflows/coding-standards.yml)
7+
[![Static Analysis](https://github.com/bearsunday/BEAR.QueryRepository/actions/workflows/static-analysis.yml/badge.svg)](https://github.com/bearsunday/BEAR.QueryRepository/actions/workflows/static-analysis.yml)
8+
[![Continuous Integration](https://github.com/bearsunday/BEAR.QueryRepository/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/bearsunday/BEAR.QueryRepository/actions/workflows/continuous-integration.yml)
9+
10+
**BEAR.QueryRepository** は、[CQRS](http://martinfowler.com/bliki/CQRS.html) にインスパイアされた分散キャッシュフレームワークで、BEAR.Resource アプリケーションのパフォーマンスとリソース利用効率を最適化します。読み取り(クエリ)と書き込み(コマンド)を分離することで、効率的なキャッシュ管理を実現します。
11+
12+
## 主な機能
13+
14+
- **イベント駆動型キャッシュ無効化**: データ変更時にキャッシュを自動的に無効化し、一貫性を保ちます。
15+
- **依存解決**: リソース間の依存関係を解決し、関連するキャッシュを自動的に更新します。
16+
- **ドーナッツキャッシュ**: 動的コンテンツと静的コンテンツを組み合わせた部分キャッシュを実現します。
17+
- **CDN統合**: FastlyAkamaiなどのモダンなCDNと連携し、共有キャッシュを効率的に管理します。
18+
- **ETagを利用した条件付きリクエスト**: `304 Not Modified` レスポンスでネットワークリソースを節約します。
19+
- **分散キャッシュサポート**: サーバーサイドキャッシュ(例: RedisAPC)、共有キャッシュ(例: CDN)、クライアントサイドキャッシュに対応します。
20+
21+
## ドキュメント
22+
23+
詳細は [BEAR.Sunday キャッシュマニュアル](http://bearsunday.github.io/manuals/1.0/ja/cache.html) をご覧ください。

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,17 @@
77
[![Static Analysis](https://github.com/bearsunday/BEAR.QueryRepository/actions/workflows/static-analysis.yml/badge.svg)](https://github.com/bearsunday/BEAR.QueryRepository/actions/workflows/static-analysis.yml)
88
[![Continuous Integration](https://github.com/bearsunday/BEAR.QueryRepository/actions/workflows/continuous-integration.yml/badge.svg)](https://github.com/bearsunday/BEAR.QueryRepository/actions/workflows/continuous-integration.yml)
99

10-
BEAR.QueryRepository is a distributed cache famework for BEAR.Resource application.
11-
[CQRS](http://martinfowler.com/bliki/CQRS.html) inspired **BEAR.QueryRepository** segregates reads and writes into two separate repository.
10+
**BEAR.QueryRepository** is a distributed caching framework for BEAR.Resource applications, inspired by [CQRS](http://martinfowler.com/bliki/CQRS.html). It segregates reads and writes into separate repositories to optimize performance and resource utilization.
1211

13-
Documentation is available at [BEAR.Sunday cache manual](http://bearsunday.github.io/manuals/1.0/ja/cache.html).
12+
## Key Features
1413

14+
- **Event-Driven Cache Invalidation**: Automatically invalidates cache when data changes, ensuring consistency.
15+
- **Dependency Resolution**: Resolves dependencies between resources and updates related caches automatically.
16+
- **Donut Caching**: Combines dynamic and static content for efficient partial caching.
17+
- **CDN Integration**: Seamlessly integrates with modern CDNs (e.g., Fastly, Akamai) for shared cache management.
18+
- **Conditional Requests with ETag Support**: Reduces network overhead by leveraging `ETag` and `304 Not Modified` responses.
19+
- **Distributed Cache Support**: Works with server-side caches (e.g., Redis, APC), shared caches (e.g., CDNs), and client-side caches.
1520

16-
## Demo
21+
## Documentation
1722

18-
```
19-
php demo/run.php
20-
```
23+
For more details, check out the [BEAR.Sunday cache manual](http://bearsunday.github.io/manuals/1.0/ja/cache.html).

0 commit comments

Comments
 (0)