New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve README of main project #7

Open

pepijn opened this issue Apr 4, 2021 · 0 comments

Labels

Milestone

Owner

pepijn commented Apr 4, 2021 •

edited

Loading

Should contain:

Overview of the different subprojects: ring adapter, background adapter, commons.
Recommendation to use the ring adapter in conjunction with pubsub.
Introduction to the Pubsub middleware.
Instructions on deployment and explain the javac compilation.
Add a dependency diagram.
Explaining that GCF is like Cloud Run so the function 'stays warm' between requests (until a certain timeout).

Explain why using namespaced maps

https://clojure.org/guides/spec

For example, most Ring middleware functions modify the request or response map with unqualified keys. However, each middleware could instead use namespaced keys with registered semantics for those keys. The keys could then be checked for conformance, creating a system with greater opportunities for collaboration and consistency.

The text was updated successfully, but these errors were encountered:

pepijn added the documentation label

pepijn added this to the 0.1.0 Release milestone

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment