Skip to content

Commit

Permalink
Merge pull request #13 from poef/master
Browse files Browse the repository at this point in the history
Updated dependencies and readme
  • Loading branch information
poef committed Jan 27, 2016
2 parents a93b04c + 40e47e6 commit 290fdbc
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 16 deletions.
52 changes: 40 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,47 @@ ARC: Ariadne Component Library
A flexible component library for PHP 5.4+
-----------------------------------------

The Ariadne Component Library is a spinoff from the Ariadne Web
Application Framework and Content Management System
[ http://www.ariadne-cms.org/ ]
ARC is a set of components, build to be as simple as possible. Each component does just one thing and has a small and
simple API to learn. ARC uses static factory methods to simplify the API while using Dependency Injection. ARC is not a
framework. It can be used in combination with any framework or indeed without.

Installation
------------

Install via Composer:
The Ariadne Component Library is a spinoff from the Ariadne Web Application Platform and Content Management System
[http://www.ariadne-cms.org/](http://www.ariadne-cms.org/). Many of the concepts used in ARC have their origin in Ariadne
and have been in use since 2000.

php composer.phar create-project arc/arc {$path}

This will download and install all arc components.
A unique feature in most components is that they are designed to work in and with a tree structure. URL's
are based on the concept of paths in a filesystem. This same path concept and the underlying filesystem-like tree is
used in most ARC components.

Installation
------------

[arc-travis]: https://travis-ci.org/Ariadne-CMS/arc-arc
[arc-packagist]: https://packagist.org/packages/arc/arc
Via [Composer](https://getcomposer.org/doc/00-intro.md):

$ composer require arc/arc

or start a new project with arc

$ composer create-project arc/arc {$path}

This will download and install all arc components.

But you don't need to do this, you can just download the components
you really need instead. Below is a list of components and what they do:

Components
----------
- [`arc/base`](https://github.com/Ariadne-CMS/arc-base/): Common datatypes and functionality shared by all ARC components.
Is installed automatically if needed.
- [`arc/cache`](https://github.com/Ariadne-CMS/arc-cache/): Cache functionality and a caching proxy class.
- [`arc/events`](https://github.com/Ariadne-CMS/arc-events/): Fire events and listen for them in a tree structure,
modelled after the browsers DOM events.
- [`arc/config`](https://github.com/Ariadne-CMS/arc-config/): Configuration management, storing and retrieving
configuration settings in a tree structure.
- [`arc/web`](https://github.com/Ariadne-CMS/arc-web/): Simple and correct manipulation of URL's, HTTP Headers
and a HTTP client. Also includes a simple intrustion detection component to prevent cross site scripting attacks.
- [`arc/xml`](https://github.com/Ariadne-CMS/arc-xml/): Parsing and writing XML made simple.
- [`arc/html`](https://github.com/Ariadne-CMS/arc-html/): Parsing and writing HTML also made simple.
- [`arc/grants`](https://github.com/Ariadne-CMS/arc-grants/): Access control management in a tree structure, like a
filesystem.
- [`arc/prototype`](https://github.com/Ariadne-CMS/arc-prototype/): Experimental prototypical inheritance, like javascript.
10 changes: 6 additions & 4 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,14 @@
],
"require": {
"php": ">=5.4",
"arc/base": "~1.0",
"arc/web": "~1.0",
"arc/xml": "~1.0",
"arc/base": "~2.0",
"arc/web": "~2.0",
"arc/xml": "~2.0",
"arc/html": "~1.0",
"arc/cache": "~1.0",
"arc/config": "~1.0",
"arc/grants": "~1.0",
"arc/events": "~1.0"
"arc/events": "~1.0",
"arc/prototype": "~0.9"
}
}

0 comments on commit 290fdbc

Please sign in to comment.