Skip to content

Commit

Permalink
Moved autoloader to overview, tweaked composer
Browse files Browse the repository at this point in the history
  • Loading branch information
tedivm committed May 17, 2014
1 parent ea8aeaa commit 12908a8
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 30 deletions.
11 changes: 0 additions & 11 deletions Basics.rst
Expand Up @@ -4,17 +4,6 @@
Basic Usage Basic Usage
=========================== ===========================


Stash is a simple to use library with powerful features.

Autoloading
===========

The Stash library conforms to the PSR-0 autoloading standard. If your project
doesn't already use a PSR-0 compliant autoloader, you can simply include the
`autoload.php` file at the root of the project to load Stash classes.

All of Stash's classes live in the Stash namespace.



Creating Stash Objects Creating Stash Objects
====================== ======================
Expand Down
42 changes: 23 additions & 19 deletions Overview.rst
Expand Up @@ -17,36 +17,26 @@ Installation
Composer Composer
-------- --------


For most projects Composer is the ideal method of installation. Stash is present Composer is the preferred method of installation. Stash is present
on `Packagist <https://packagist.org/packages/tedivm/stash>`_, making on `Packagist <https://packagist.org/packages/tedivm/stash>`_, making
installation as easy as adding a directive to your project's composer.json file. installation as easy as adding a directive to your project's composer.json file.


The simpliest way to use Composer is to include the latest version of Stash. Until Stash reaches a stable API with version 1.0 it is recommended that you
review changes before even Minor updates, although bug fixes will always be
backwards compatible.


.. code-block:: none .. code-block:: yaml
"require": {
"tedivm/stash": "*"
}
The downside to this is that API changes can occur which will break the project.
Composer allows specific versions or lines of development to be used. This
example, which is the preferred method, installs the latest version of the v0.10
line of development, allowing for the latest enhancements but without the need
to worry about backwards compatibility breaking changes occurring.

.. code-block:: none
"require": { "require": {
"tedivm/stash": "0.12.*" "tedivm/stash": "0.12.*"
} }
For project looking to take advantage of the latest features it's also possible For project looking to take advantage of the latest features it's also possible
to install directly against the main development line. This is ideal for to install directly against the main development line. This is ideal for
testing, but should be limited to non-production code. testing, but should be limited to non-production code.


.. code-block:: none .. code-block:: yaml
"require": { "require": {
"tedivm/stash": "dev-master" "tedivm/stash": "dev-master"
Expand All @@ -59,8 +49,22 @@ website at http://getcomposer.org/.
Direct Download Direct Download
--------------- ---------------


Releases of Stash are available for direct download on `Github Versions of Stash are available as `Releases <https://github.com/tedivm/Stash/releases>`_.
<https://github.com/tedivm/Stash/releases>`_. on Github.


Autoloading
===========

If you installed using composer then you simply need to include it's autoloader.
This is the preferred method of loading Stash.

Stash confirms to PSR-0 and places it's code in the src folder, making it easy
to include in a custom autoloader. This means "Stash\Pool" can be found in
"src\Stash\Pool.php"..

If all else fails there is an autoloader that is packaged with Stash itself.
Just include "autoload.php".




License License
Expand Down

0 comments on commit 12908a8

Please sign in to comment.