Skip to content

Commit

Permalink
♻️ Fix: README
Browse files Browse the repository at this point in the history
  • Loading branch information
naohito-T committed Apr 13, 2024
1 parent f0e0ec1 commit 1086315
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 3 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/auto_pr_prod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on:
workflow_dispatch:
push:
branches:
- "release"
- "develop"

jobs:
create-pr-prod:
Expand All @@ -18,7 +18,7 @@ jobs:
run: |
if ! gh pr list -B main | grep OPEN; then
gh pr create \
--head release \
--head develop \
--base main \
--title "Deploy to production 🎉" \
--body "Deploy to production!" \
Expand Down
4 changes: 4 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,9 @@
"editor.codeActionsOnSave": {
"source.organizeImports": "explicit"
}
},
"markdownlint.config": {
"MD013": false,
"MD033": false
}
}
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
# tinyurl

## overview
<details>
<summary style="font-size: 20px">🔱 CI Actions Status</summary>
[![[main] Test Backend](https://github.com/naohito-T/tinyurl/actions/workflows/test_backend.yml/badge.svg?branch=main)](https://github.com/naohito-T/tinyurl/actions/workflows/test_backend.yml)
</details>

## Overview

短縮URLを作成するサービス

## Usage
<!-- 簡単な使い方です。 -->

## Feature

- SHA1ハッシュを使用して入力URLのランダムなハッシュを生成し、同じものが`dynamoDB`データベースの入力URLにマッピングされます。
Expand All @@ -14,3 +22,11 @@

このプロジェクトに貢献したい方は以下のドキュメントを参考にしてください。
[CONTRIBUTING](./CONTRIBUTING.md)

## Author

@naohito-T

## License

[MIT](./LICENSE)

0 comments on commit 1086315

Please sign in to comment.