docs: update README

frouriojs · Sep 15, 2024 · 6a6bbda · 6a6bbda
1 parent 36f0a8e
commit 6a6bbda
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 0 deletions.
diff --git a/Makefile b/Makefile
@@ -0,0 +1,13 @@
+setup: install
+	cp client/.env.example client/.env
+	cp server/.env.example server/.env
+	docker compose up -d
+
+install:
+	npm install & npm install --prefix server & npm install --prefix client
+
+release:
+	@echo ${VERSION} | grep -E "^[0-9]+\.[0-9]+\.[0-9]+(-r[0-9]+)?$$"
+	git fetch origin main
+	git tag v${VERSION} FETCH_HEAD
+	git push origin v${VERSION}
diff --git a/README.md b/README.md
@@ -33,6 +33,7 @@ services:
     ports:
       - 5050:5050 # Cognito API
       - 5051:5051 # web interface
+      - 5052:5052 # OAuth2 SSL endpoint
     environment:
       COGNITO_USER_POOL_ID: ap-northeast-1_example
       COGNITO_USER_POOL_CLIENT_ID: example-client-name
@@ -91,6 +92,7 @@ You can check the emails sent by Magnito with Inbucket.
 - Sign In
 
   - Sign in with your email address and password.
+  - Sign in with Google / Apple / Amazon / Facebook emulators.
 
 - Forgot Password
 

diff --git a/docs/screenshots/admin.png b/docs/screenshots/admin.png
diff --git a/docs/screenshots/sign-in.png b/docs/screenshots/sign-in.png