From 6946ffe7aeca30b07663d789822706cba3e06e99 Mon Sep 17 00:00:00 2001
From: Brad Fitzpatrick
Date: Tue, 11 Jun 2013 15:36:25 +0200
Subject: [PATCH] More docs
Change-Id: Iac190f16a2b48464e465b69e266bff649fe387d4
---
README | 20 +++++++++++++++-----
website/content/docs/release/0.1 | 20 +++++++++++++++++---
website/content/index.html | 17 ++++++++++++++---
3 files changed, 46 insertions(+), 11 deletions(-)
diff --git a/README b/README
index 26c0248d9..9b1d92007 100644
--- a/README
+++ b/README
@@ -1,11 +1,21 @@
-Camlistore is a way to store, sync, share, model and back up content.
+Camlistore is your personal storage system for life.
+
+It's a way to store, sync, share, model and back up content.
It stands for "Content-Addressable Multi-Layer Indexed Storage", for
-lack of a better name.
-
-See:
+lack of a better name. For more, see:
http://camlistore.org/
-... for actual documentation.
+Other useful files:
+ BUILDING how to compile it ("go run make.go")
+ HACKING how to do development and contribute
+
+Mailing lists:
+
+ http://camlistore.org/lists
+
+Bugs:
+
+ https://code.google.com/p/camlistore/issues/list
diff --git a/website/content/docs/release/0.1 b/website/content/docs/release/0.1
index 2f817ac1a..a4d4f1595 100644
--- a/website/content/docs/release/0.1
+++ b/website/content/docs/release/0.1
@@ -16,6 +16,8 @@ Or browse at Github: g
it's at least ready for people to start using and playing with. We've
been using it ourselves for a year.
+We plan to do subsequent releases in a more timely fashion.
+
What works
@@ -27,12 +29,18 @@ been using it ourselves for a year.
camtool
: additional swiss-army knife tools, and manual sync tool ("camtool sync").
- Web UI. Not great, but lets you browse your Camlistore resources.
+ camlistored
: the server.
+ Web UI (optional part of the server, on by default). Not great, but lets you browse your Camlistore resources.
Android client: upload photos ("Share to Camlistore")
Blob storage options: local disk, Amazon S3, Google Cloud Storage, ...
Search index storage options: in-memory, SQLite, MySQL, Postgres, Mongo, ...
- Synchronous and asynchronous replication support between any storage types or Camlistore instances.
- Sharding, mirroring, ...
+ All sorts of replication:
+
+ camlistored
: The server supports both asynchronous and synchronous replication from incoming blobs to any storage backend, which includes other remote Camlistore servers
+ camtool sync
: The camtool command supports syncing from servers (or local disk blob directories) to other servers (or other local disk blob directories), as well as a "third-leg" mode, where you can sync from A to B> by using the network to communicate differences, but instead copying missing blobs to destination C (e.g. a local portable harddisk to be manually transported to B)
+
+
+ Sharding, mirroring, unioning, ...
@@ -54,6 +62,7 @@ been using it ourselves for a year.
Much is planned:
+ - Much more documentation
- Photo gallery & blog serving
- More sharing support
- Encryption
@@ -70,5 +79,10 @@ Much is planned:
contributions. See the Contributing
page.
+While most the codebase (the server and command-line tools) are
+written in Go, there's also a lot of
+JavaScript which needs love, as well as Java (for Android) and
+Objective C (for iOS). Or anything useful you'd like to contribute.
+
File bugs at: https://code.google.com/p/camlistore/issues/entry.
diff --git a/website/content/index.html b/website/content/index.html
index a691d75db..5b7763281 100644
--- a/website/content/index.html
+++ b/website/content/index.html
@@ -1,6 +1,15 @@
What is Camlistore?
-Camlistore is your personal storage system for life. It is:
+Camlistore is your personal storage system for life.
+
+Note that it's a "storage system", not just a "file system". It
+can store and be accessed like a traditional filesystem, but it
+specializes in representing higher-level objects which don't need to
+exist in purely one place in a tree. (e.g. a photo, a comment, a
+"like", a blog post) Or a tree of 5TB videos with Unix mode bits that
+you can access via a FUSE filesystem. Whatever.
+
+It is:
- a way to store, sync, share, model and back up content
- everything private by default
@@ -8,7 +17,7 @@
- Open Source (Apache licensed)
- an acronym for "Content-Addressable Multi-Layer Indexed Storage", saying that Camlistore is about:
- - content-addressable storage (at the lowest layer)
+ - content-addressable storage, at the lowest layer ("Like git for all content in your life")
- separate interoperable parts (storage, sync, sharing,
modeling), with well-defined protocols and roles
- indexing and searching your content
@@ -21,7 +30,9 @@
- simple!
- programming language-agnostic (parts and different implementations in Go, Python, Java, Perl, Bash, ... the language doesn't matter.) What matters is well-defined, simple HTTP interfaces.
- neither "Cloud" nor "Local". happily both. Run it on your own machine (any OS, any architecture), your phone, EC2, App Engine, Heroku, whatever.
- - a "20% project" from a few Google employees, but not Google-centric nor endorsed by Google (other than them letting us open source our side project)
+ - a "20% project" from a few Google employees (and non-Googlers),
+ but not Google-centric nor endorsed by Google (other than them
+ letting us open source our side project)
Latest Release