diff --git a/.gitignore b/.gitignore index bc9318a..1d4c5f2 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,8 @@ html pkg doc +ydoc +.yardoc *.gem nbproject *.bundle @@ -11,3 +13,4 @@ benchmark *~ *#* *.class +*.swp diff --git a/README.md b/README.md index 7bbffbb..3d5ae7e 100644 --- a/README.md +++ b/README.md @@ -71,7 +71,7 @@ That's all there is to it! For extensive examples, see the [MongoDB Ruby Tutorial](http://www.mongodb.org/display/DOCS/Ruby+Tutorial). -Bundled with the driver are many examples, located in the "examples" subdirectory. Samples include using +Bundled with the driver are many examples, located in the "docs/examples" subdirectory. Samples include using the driver and using the GridFS class GridStore. MongoDB must be running for these examples to work, of course. @@ -81,7 +81,7 @@ Here's how to start MongoDB and run the "simple.rb" example: $ ./mongod run ... then in another window ... $ cd path/to/mongo-ruby-driver - $ ruby examples/simple.rb + $ ruby docs/examples/simple.rb See also the test code, especially test/test_db_api.rb. diff --git a/CREDITS b/docs/CREDITS.md similarity index 100% rename from CREDITS rename to docs/CREDITS.md diff --git a/HISTORY b/docs/HISTORY.md similarity index 100% rename from HISTORY rename to docs/HISTORY.md diff --git a/examples/admin.rb b/docs/examples/admin.rb similarity index 100% rename from examples/admin.rb rename to docs/examples/admin.rb diff --git a/examples/capped.rb b/docs/examples/capped.rb similarity index 100% rename from examples/capped.rb rename to docs/examples/capped.rb diff --git a/examples/cursor.rb b/docs/examples/cursor.rb similarity index 100% rename from examples/cursor.rb rename to docs/examples/cursor.rb diff --git a/examples/gridfs.rb b/docs/examples/gridfs.rb similarity index 100% rename from examples/gridfs.rb rename to docs/examples/gridfs.rb diff --git a/examples/index_test.rb b/docs/examples/index_test.rb similarity index 100% rename from examples/index_test.rb rename to docs/examples/index_test.rb diff --git a/examples/info.rb b/docs/examples/info.rb similarity index 100% rename from examples/info.rb rename to docs/examples/info.rb diff --git a/examples/queries.rb b/docs/examples/queries.rb similarity index 100% rename from examples/queries.rb rename to docs/examples/queries.rb diff --git a/examples/simple.rb b/docs/examples/simple.rb similarity index 100% rename from examples/simple.rb rename to docs/examples/simple.rb diff --git a/examples/strict.rb b/docs/examples/strict.rb similarity index 100% rename from examples/strict.rb rename to docs/examples/strict.rb diff --git a/examples/types.rb b/docs/examples/types.rb similarity index 100% rename from examples/types.rb rename to docs/examples/types.rb