diff --git a/README.md b/README.md index d4a45c4..7857aa4 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,16 @@ # id OAuth authentication service for ByeCorps & other services + +## FAQ + +### What is a ByeCorps ID? + +A ByeCorps ID (BCID) is a seven digit alphanumeric (non-case sensitive) code used to identify a person. It is used to reduce the need of multiple accounts across ByeCorps services, as well as third-party services using OAuth (though a password alternative is reccommneded instead of BCID only) + +## Official connonical domain names + +Only input your BCID on the following domain names ONLY on a HTTPS connection (look for the padlock): + +- https://id.byecorps.com + +Any other domain name or an insecure connection might be a phishing attempt, so be careful. **NEVER** input your BCID password on any other domain. diff --git a/id/__init__.py b/id/__init__.py new file mode 100644 index 0000000..2a5def9 --- /dev/null +++ b/id/__init__.py @@ -0,0 +1,2 @@ +# ByeCorps ID +