Auth0 Github Project Checklist

README.md

Project Title

Description of project

Key features

• Key Feature 1
• Key Feature 2
• Key Feature 3

Install

How to get the sample or install the product

Usage

How to run the sample or start using the product

API Reference

Details on the API if applicable

Examples

Examples of how to use the sample/product

README_FOOTER_INFRA.md

For general open source projects (not samples, SDKs, etc.) the following footer sections should be included in the README.md file.

Issue Reporting

If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

Author

Auth0

License

This project is licensed under the MIT license. See the LICENSE file for more info.

README_FOOTER_SDK.md

For SDKs and samples the following footer sections should be included in the README.md file.

What is Auth0?

Auth0 helps you to:

• Add authentication with multiple authentication sources, either social like Google, Facebook, Microsoft Account, LinkedIn, GitHub, Twitter, Box, Salesforce, amont others, or enterprise identity systems like Windows Azure AD, Google Apps, Active Directory, ADFS or any SAML Identity Provider.
• Add authentication through more traditional username/password databases.
• Add support for linking different user accounts with the same user.
• Support for generating signed Json Web Tokens to call your APIs and flow the user identity securely.
• Analytics of how, when and where users are logging in.
• Pull data from other sources and add it to the user profile, through JavaScript rules.

Create a free Auth0 Account

1. Go to Auth0 and click Sign Up.
2. Use Google, GitHub or Microsoft Account to login.

Issue Reporting

If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

Author

Auth0

License

This project is licensed under the MIT license. See the LICENSE file for more info.

Checklist.md

Github Checklist

The standard requirements for any github project on github.com/auth0.

• Must have README.md
• Must have LICENSE file - generally MIT
• Must have .gitignore file: https://github.com/github/gitignore
• Must have a metadata.json file if it is a Sample, SDK, Tutorial, or Demo
• Must have a /examples folder with at least one example showing how to use the project (except samples)
• Must have description field of github project set with meaningful description of project
• Should have url field of github project set

Repository Naming

Type	Naming Convention
SDKs	auth0-{language}-sdk
Samples	auth0-{language}-{name}-sample
Demos	auth0-demo-{demo}-{name}

LICENSE

The MIT License (MIT)

Copyright (c) 2015 Auth0, Inc. <support@auth0.com> (http://auth0.com)

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

metadata.json

{
  "name": "Sample/SDK Name",
  "type": "sample|sdk|tutorial|demo",
  "tags": [
    "amazon-s3",
    "browser",
    "javascript",
    "single-page-app"
  ]
}