Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
Updated documentation.
  • Loading branch information
gcv committed Nov 20, 2010
1 parent 74bb086 commit 012292f
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 5 deletions.
3 changes: 2 additions & 1 deletion HISTORY.md
@@ -1,5 +1,6 @@
## 0.3.0 (???)

* Added `appengine-magic.core/appengine-environment-type`.
* Deprecated including the `:aot` directive in `project.clj` files.
* Added `exists?` function to the Datastore service.
* Added the Task Queues service.
Expand All @@ -8,7 +9,7 @@
* Speeded up production deployment by packaging compiled application .class
files into a .jar. Eliminated the WEB-INF/classes/ directory.
* Added support for general classpath resources with the
`appengine-magic/open-resource-stream` function.
`appengine-magic.core/open-resource-stream` function.
* Breaking change: moved the web application from `resources/war/` to
`resources/`. This provides better support for using general classpath
resources.
Expand Down
18 changes: 14 additions & 4 deletions README.md
Expand Up @@ -168,10 +168,10 @@ put a file called `index.html` there, it will become a default welcome file.
### Classpath resources

Put all classpath resources you expect to need at runtime in `resources/`. You
can then access them using the `appengine-magic/open-resource-stream`, which
returns a `java.io.BufferedInputStream` instance. Please note that, by default,
App Engine then makes these resources available as static files. To change this
behavior, you need to modify `appengine-web.xml` file. See [Google
can then access them using the `appengine-magic.core/open-resource-stream`,
which returns a `java.io.BufferedInputStream` instance. Please note that, by
default, App Engine then makes these resources available as static files. To
change this behavior, you need to modify `appengine-web.xml` file. See [Google
documentation](http://code.google.com/appengine/docs/java/config/appconfig.html)
for details.

Expand All @@ -191,6 +191,16 @@ work consistently across all App Engine environments.
application's `resources/` directory.


### Checking the runtime environment

It is sometimes useful to know if the current execution environment is the
production App Engine, `dev_appserver.sh`, or the interactive REPL. For example,
you may wish to return more detailed error messages and stack traces in
non-production mode. `appengine-magic.core/appengine-environment-type` returns a
keyword corresponding to the current environment: `:production`,
`:dev-appserver`, and `:interactive`.


### Automatic testing code

The `clojure.test` system works well for testing `appengine-magic` applications,
Expand Down

0 comments on commit 012292f

Please sign in to comment.