Skip to content

Commit

Permalink
Merge pull request #30 from 2rabs/rt/update-readme
Browse files Browse the repository at this point in the history
📚 README を更新
  • Loading branch information
tatsutakein authored Nov 21, 2023
2 parents 852b645 + b7c1a44 commit f110bb8
Show file tree
Hide file tree
Showing 5 changed files with 33 additions and 9 deletions.
42 changes: 33 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,30 @@
![NITO](docs/images/hero.svg)

<a href='https://play.google.com/store/apps/details?id=club.nito.app&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'><img alt='Google Play で手に入れよう' src='docs/images/google-play/badge.png' height='80px'/></a>

# NITO

NITO のユーザーアプリです。

<a href='https://play.google.com/store/apps/details?id=club.nito.app&pcampaignid=pcampaignidMKT-Other-global-all-co-prtnr-py-PartBadge-Mar2515-1'><img alt='Google Play で手に入れよう' src='docs/images/google-play/badge.png' height='100px'/></a>
## Features

NITO は実施予定の一覧と詳細を表示します。ユーザーはそのスケジュールを確認することができます。参加表明も可能です。

### Screenshots

![Screenshot showing For Top screen and Schedule list screen](docs/images/screenshots.png "Screenshot showing For Top screen and Schedule list screen")

## Development Environment

## Screenshots
TBD

<img alt='screenshot-01' src='docs/images/google-play/screenshot-01.png' width='300px'/><img alt='screenshot-02' src='docs/images/google-play/screenshot-02.png' width='300px'/><img alt='screenshot-03' src='docs/images/google-play/screenshot-03.png' width='300px'/>
## Architecture

- [Kotlin Multiplatform](https://kotlinlang.org/lp/multiplatform/)
- [Jetpack Compose](https://developer.android.com/jetpack/compose?hl=ja)
- [SwiftUI](https://developer.apple.com/jp/xcode/swiftui/)

## ディレクトリ構成
## Modularization

```text
.
Expand All @@ -20,15 +34,25 @@ NITO のユーザーアプリです。
│   ビルドロジックを集約したディレクトリ
├── build-logic
│   各 feature モジュールで使用する共通のモジュールを集約したディレクトリ
│   各機能モジュールで使用する共通のモジュールを集約したディレクトリ
├── core
│   各機能モジュールのディレクトリ
└── feature
```

## アーキテクチャ構成
## Build

- [Kotlin Multiplatform](https://kotlinlang.org/lp/multiplatform/)
- [Jetpack Compose](https://developer.android.com/jetpack/compose?hl=ja)
- [SwiftUI](https://developer.apple.com/jp/xcode/swiftui/)
TBD

## Testing

TBD

## Performance

TBD

## License

NITO is distributed under the terms of the MIT License. See the [license](LICENSE) for more information.
Binary file removed docs/images/google-play/screenshot-01.png
Binary file not shown.
Binary file removed docs/images/google-play/screenshot-02.png
Binary file not shown.
Binary file removed docs/images/google-play/screenshot-03.png
Binary file not shown.
Binary file added docs/images/screenshots.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f110bb8

Please sign in to comment.