Skip to content

Instantly share code, notes, and snippets.

@ocubom
Last active August 25, 2016 16:37
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 1 You must be signed in to fork a gist
  • Save ocubom/5394892 to your computer and use it in GitHub Desktop.
Save ocubom/5394892 to your computer and use it in GitHub Desktop.
Few README templates

AcmeAuthBundle

Provides the authentication layer for ACME developments.

This bundle is a split of an internal project developed at ACME.

Documentation

Full documentation sources are available in Resources/doc directory.

The documentation is written in reST a legible plain text format. You can also build a HTML or printable version of the documentation:

cd Resources/doc
make dirhtml # for web version
make pdf     # for printable version

In both cases your system must meet Sphinx requirements.

Installation

  1. Just add to composer.json file the lines:

    {
        "require": {
            "acme/auth-bundle": ">=1.0"
        }
    }
  2. And update the dependencies:

    composer update acme/auth-bundle

Read the more detailed instructions in the documentation.

Authorship

Current maintainer:

Copyright and License

AcmeAuthBundle is licensed under the MIT License - see the Resources/meta/LICENSE file for details.

If you did not receive a copy of the license, contact with ACME.

ACME Auth

Provides the authentication layer for ACME developments.

This component is a split of an internal project developed at ACME rewrited from scratch.

Documentation

Full documentation sources are available in doc directory.

The documentation is written in reST a legible plain text format. You can also build a HTML or printable version of the documentation:

cd Resources/doc
make dirhtml # for web version
make pdf     # for printable version

In both cases your system must meet Sphinx requirements.

Installation

  1. Just add to composer.json file the lines:

    {
        "require": {
            "acme/component": ">=1.0"
        }
    }
  2. And update the dependencies:

    composer update acme/component

Read the more detailed instructions in the documentation.

Authorship

Current maintainer:

Copyright and License

ACME Component is licensed under the MIT License - see the LICENSE file for details.

If you did not receive a copy of the license, contact with ACME.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment