From 6d806c60762c0403d6bce6608c28a03991dc66aa Mon Sep 17 00:00:00 2001
From: Kentaro Ozeki <32771324+ozekik@users.noreply.github.com>
Date: Wed, 2 Oct 2024 00:00:00 +0900
Subject: [PATCH] update: update readme and docs
---
README.md | 22 +++++++++++++++++++++-
docs/index.md | 10 +++++++++-
2 files changed, 30 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 5002d95..19c482b 100644
--- a/README.md
+++ b/README.md
@@ -14,6 +14,16 @@
- **ドキュメント Documentation:**
- **ブラウザで試す (試験版) Try in Your Browser (Experimental):**
+## 目次 Table of Contents
+
+- [機能 Features](#機能-features)
+- [インストール Installation](#インストール-installation)
+- [活用事例 Use Cases](#活用事例-use-cases)
+- [ロードマップ Roadmap](#ロードマップ-roadmap)
+- [その他のツール・ライブラリ Alternatives](#その他のツールライブラリ-alternatives)
+- [クレジット Credits](#クレジット-credits)
+- [ライセンス License](#ライセンス-license)
+
## 機能 Features
- [x] PLATEAUデータセットのインストール・管理
@@ -28,9 +38,19 @@
## インストール Installation
```sh
-pip install plateaukit
+pip install 'plateaukit[all]'
```
+- 詳細は[PlateauKitのインストール](https://ozekik.github.io/plateaukit/install/)を参照
+
+## 活用事例 Use Cases
+
+PlateauKit + PlateauLab を開発の一部でお使いいただいている事例を紹介しています。
+事例の追加・修正は[Issues](https://github.com/ozekik/plateaukit/issues)または[Pull Requests](https://github.com/ozekik/plateaukit/pulls)からお知らせください。
+
+- **[AIまちづくりファシリテーター](https://protopedia.net/prototype/6072) (チーム シャキシャキ)** 🏆**グランプリ**, PLATEAU Hack Challenge 2024 in Tokyo
+- **[PLATEAUを利用した名古屋市の犯罪マップと類似領域検索](https://www.mlit-data.jp/#/ShowcaseDetail?id=Showcase18) (向 直人氏)** 🏆**国土交通データプラットフォーム特別賞**, アーバンデータチャレンジ2023 with 土木学会インフラデータチャレンジ2023
+
## ロードマップ Roadmap
- [x] ドキュメントの整備
diff --git a/docs/index.md b/docs/index.md
index 6db7fb8..810c8bd 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -26,9 +26,17 @@ PlateauKit は 国土
## インストール Installation
```bash
-pip install plateaukit
+pip install 'plateaukit[all]'
```
- [PlateauKitのインストール](install.md)を参照
+## 活用事例 Use Cases
+
+PlateauKit + PlateauLab を開発の一部でお使いいただいている事例を紹介しています。
+事例の追加・修正は[Issues](https://github.com/ozekik/plateaukit/issues)または[Pull Requests](https://github.com/ozekik/plateaukit/pulls)からお知らせください。
+
+- **[AIまちづくりファシリテーター](https://protopedia.net/prototype/6072) (チーム シャキシャキ)** 🏆**グランプリ**, PLATEAU Hack Challenge 2024 in Tokyo
+- **[PLATEAUを利用した名古屋市の犯罪マップと類似領域検索](https://www.mlit-data.jp/#/ShowcaseDetail?id=Showcase18) (向 直人氏)** 🏆**国土交通データプラットフォーム特別賞**, アーバンデータチャレンジ2023 with 土木学会インフラデータチャレンジ2023
+