Agama Project README Style Guide

Agama Project Readme's should look like this:

Agama ______

This Agama Project <solves the following list of challenges> for the <list of use cases>. For more information you can also see

• Vendor Home Page
• Relevant Open Standards
• Other helpful links

Requirements

• Agama Dependency: Name of Agama Project (link to Github home for project)
• Third Party Accounts: Any other info needed for this project to work

Supported IDPs

IDP	Description
Jans Auth Server	Deployment instructions
Gluu Flex	Deployment instructions
Keycloak	Deployment instructions

Each IDP (Jans, Gluu, KC) should have a markdown page with any platform specific instructions, for example, jans-deploy.md, gluu-deploy.md, and kc-deploy.md And each of these markdown pages would contain any platform specific information, like what jars to install or screenshots about how to deploy.

Flows

Qualified Name	Description
org.gluu.agama.<name>.<flow1>	Stuff that happens in flow 1
org.gluu.agama.<name>.<flow2>	More stuff that happens in flow 2
org.gluu.agama.<name>.<flow3>	Different stuff that happens in flow 3

Configuration

Flow	Property	Value Description
org.gluu.agama.<name>.<flow2>	ACCOUNT_ID	client id
org.gluu.agama.<name>.<flow2>	AUTH_TOKEN	yucky static token

Sample JSON:

    {
        "org.gluu.agama.<name>.<flow1>": {},
        "org.gluu.agama.<name>.<flow2>": {
          "ACCOUNT_ID": "PUT_YOUR__ACCOUNT_ID_HERE",
          "AUTH_TOKEN": "PUT_YOUR_AUTH_TOKEN_HERE"
        }
    }

Sequence Diagrams

Optional

org.gluu.agama.<name>.<flow1>

(sequence diagram)

sequencediagram.org "URL to share" to sequence diagram source

Demo

Optional

Check out this video of the org.gluu.agama.<name> flow.

Contributors

Foo Bar

License

This project is licensed under the Apache 2.0