Skip to content

Commit

Permalink
Added README (Markdown syntax for GitHub)
Browse files Browse the repository at this point in the history
  • Loading branch information
Stephan Seidt committed Nov 27, 2009
1 parent a8a7cc6 commit 0b7c220
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 11 deletions.
11 changes: 0 additions & 11 deletions README

This file was deleted.

57 changes: 57 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
VRAME
=====

VRAME is a CMS (content management system) based on Ruby on Rails.
It is designed to run as a Rails Engine on top of your existing Rails app.

Philosophy
==========

VRAME does not force you into any kind of predefined, inappropriate structure.
It allows you to build and use your own information architecture.

In order to integrate VRAME with your app, it provides a few Rails models which fulfill certain tasks:

* Categories act like folders. They include schemas for their documents.
* Documents act as endpoints. They can be represented as a custom HTML template or as JSON for external APIs.
* Assets act as storage for files, mainly images. They care about thumbnail creation, video conversion, etc.
* Collections act as containers for multiple assets.

Feature Overview
----------------

* Schema Builder: Create a schema for underlying documents
* Rich types for appropriate information representation
* Google Maps integration
* Images & thumbnail creation
* Video conversion
* User management _(in progress)_

Installation
============

The following versions are required for VRAME:

* Rails >= 2.3.4
* Ruby >= 1.8.6
* MySQL >= 5.x

Adding VRAME to your Rails App
------------------------------

Currently a repository only
No gem
No version numbers yet
But that's planned

cd your_rails_app
git submodule add git://github.com/sebastiandeutsch/vrame.git vendor/plugins/vrame
git submodule add git://github.com/sebastiandeutsch/nine_auth_engine.git vendor/plugins/nine_auth_engine

Initialize VRAME
----------------

sudo rake gems:install
rake vrame:bootstrap

Copyright (c) 2009 9elements.com, released under the MIT license

0 comments on commit 0b7c220

Please sign in to comment.