initial commit

README.md

@@ -1,3 +1,11 @@
 # WB-status-api-server
 
-a lightweight web api for Watanabebashi's statuspage
+WB-status-api-server は軽量なステータスページ用APIサーバです。
+
+機能はシンプルでJSON形式で指定したURL、もしくは設定したURL全ての死活状況・HTTPステータスコードをJSON形式で返します。
+
+デフォルトで5分間死活監視結果をキャッシュするため、ステータスページにアクセスが集中しても監視先に負荷をかける心配がありません。
+
+また、大きなメリットとして本サーバは少し改良するだけでサーバーレスで運用することができます。フロントエンドのステータスページを静的サイトにし、JSで本サーバのAPIを叩かせることで運用コストを下げることができますし、ステータスページ用にサーバを用意する必要がなくなります。
+
+本サーバは現在開発中のため動作しません。