From 9d816fc9d93c78ecc66fa24fbf5696a4a59caf98 Mon Sep 17 00:00:00 2001 From: Alex Karezin Date: Tue, 22 Aug 2023 21:30:06 -0400 Subject: [PATCH] Add reference to the visual repository overview (#807) Adding a link to the high-level diagrams including module, library dependency and others (https://sourcespy.com/github/alibabajetcache/). Built directly from source and updated on schedule. Intended to simplify developer's introduction to the project. In the spirit of transparency - I am the author of the diagrams. Hope contributors find it useful. --- docs/EN/Readme.md | 3 ++- readme.MD | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/EN/Readme.md b/docs/EN/Readme.md index 1d9d76e9f..3ff75e7ab 100644 --- a/docs/EN/Readme.md +++ b/docs/EN/Readme.md @@ -38,7 +38,8 @@ see *samples* directory of the repository. * [In-memory ```Cache``` implements: LinkedHashMapCache and CaffeineCache](Embedded.md) * [Statistics](Stat.md) * [Builder API](Builder.md): If you do not use Spring Framework or want to construct ```Cache``` instance by hand coding -* [Compatibility notes](Compatibility.md) +* [Compatibility notes](Compatibility.md) +* [Repository Map](https://sourcespy.com/github/alibabajetcache/): a visual introduciton to the repository ## which artifact should I use? * jetcache-anno-api: define annotation and constants, no transitive dependencies. If you want to add JetCache annotation to your API artifact without introduce a lot of dependencies, you use jetcache-anno-api. diff --git a/readme.MD b/readme.MD index d4e25de79..a088ad4b1 100644 --- a/readme.MD +++ b/readme.MD @@ -2,6 +2,7 @@ [![Coverage Status](https://coveralls.io/repos/github/alibaba/jetcache/badge.svg?branch=master)](https://coveralls.io/github/alibaba/jetcache?branch=master) [![GitHub release](https://img.shields.io/github/release/alibaba/jetcache.svg)](https://github.com/alibaba/jetcache/releases) [![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html) +[![Project Map](https://sourcespy.com/shield.svg)](https://sourcespy.com/github/alibabajetcache/) # Introduction JetCache is a Java cache abstraction which provides uniform usage for different caching solutions.