Permalink
Browse files

The two most important files in any project, right? :)

  • Loading branch information...
0 parents commit d47a5b697a86e0b8c52481a8301b5ce83867064f Kevin Boyd committed Nov 4, 2011
Showing with 57 additions and 0 deletions.
  1. +19 −0 LICENSE
  2. +38 −0 README.md
19 LICENSE
@@ -0,0 +1,19 @@
+Copyright (c) 2011 Kevin Boyd
+
+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.
38 README.md
@@ -0,0 +1,38 @@
+# BerylliumCacheBundle for Symfony2 #
+
+It's memcache. You've seen it before. Now it's injectable to the DIC, and you don't have to write all this junk yourself.
+
+Of course, if you need it, you probably already have. And if you have, you've probably done it in a better way.
+
+Ah well. Maybe this will help a few people, maybe it won't, who knows - I'm just in it for the fame and fortune, really. ;-)
+
+The groundwork is also laid out for building alternate cache interfaces quickly - such as APC caching, or your own home-rolled filesystem cache.
+
+# Configuration #
+
+Add it to your AppKernel (this example assumes that CacheBundle is located in src/Beryllium/CacheBundle):
+
+ $bundles = array(
+ //...
+ new Beryllium\CacheBundle\BerylliumCacheBundle(),
+ );
+
+Configure your server list in parameters.ini:
+
+ beryllium_memcache.servers["127.0.0.1"] = 11211
+
+And then you should be good to go:
+
+ $this->get( 'beryllium_cache' )->set( 'key', 'value', $ttl );
+ $this->get( 'beryllium_cache' )->get( 'key' );
+
+You might want to set up a service alias, since "$this->get( 'beryllium_cache' )" might be a bit long.
+
+# The Future #
+Currently there aren't any unit or functional tests. So that needs to be worked on.
+
+More cache client implementations could be useful, if it turns out there's a demand for them.
+
+And yes, the documentation needs to be more thorough as well. For example, there ought to be documentation on how to add it to the deps file and have it placed in the Vendor folder instead of Src.
+
+Beyond that, who knows :)

0 comments on commit d47a5b6

Please sign in to comment.