Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Merge branch 'master' of github1602:compoundjs/guides

  • Loading branch information...
commit 88ab4393edab9510d77b503f3d1fdc7e2601979e 2 parents 426e6ee + 86bda73
@1602 1602 authored
Showing with 52 additions and 12 deletions.
  1. +52 −12 README.md
View
64 README.md
@@ -1,13 +1,13 @@
-## CompoundJS guides.
+## CompoundJS guides
### Basics
-#### [Getting started][1]
+#### [Getting started][crash-course]
Crash course to CompoundJS. Create your first app, learn structure, use
generators and tools.
-#### [Compound Elements Explained][2]
+#### [Compound Elements Explained][elements-explained]
Take closer look at compound elements. Every part of application do it's own
thing. This guide allows you to learn how use each part of compound and bundle
@@ -16,27 +16,67 @@ it together to create awesome application.
### Intermediate things
-#### [Routing][]
+#### [Routing][routing]
-#### [View/layouts rendering][]
+How to draw your application's routing map in few expressions. This guide
+shows you all compound routing map power and beauty.
-#### [Using helpers][]
+#### [Controllers][controllers]
-#### [Security][]
+Everything you need to know about controllers and request handling flow:
+actions, hooks, middleware stack.
+
+#### [View/layouts rendering][views]
+
+Views, layouts, templating engines and all related stuff (except helpers,
+because helpers is a big theme worth separate guide).
+
+#### [View helpers][helpers]
+
+Everything about built-in and custom-made helpers.
+Learn how to create your own helpers and helper-related techniques to simplify
+and beautify your views.
+
+#### [Security][security]
+
+Types of attacks and how to protect your app against them. Which compoundjs
+features could be helpful.
### Advanced topics
-#### [Events, Compound API][]
+#### [Meta-programming][meta-controllers]
+
+Short talk about meta-programming techniques could be used to DRY controllers and
+reuse controllers code.
+
+#### [Events, Compound API][events-api]
Learn how to use events to hook up particular application loading stages. Then
use API methods to configure compound for your application needs.
-#### [Building extensions][]
+#### [Building extensions][extensions-api]
Let's see how to extend compound and make your code reusable using extensions
API.
-#### [Deploy][]
+#### [Deploy][deploy]
+
+TODO: describe
+
+#### [Testing][testing]
+
+TODO: describe
-[1]: https://github.com/compoundjs/guides/blob/master/crash-course.md
-[2]: https://github.com/compoundjs/guides/blob/master/elements-explained.md
+[crash-course]: https://github.com/compoundjs/guides/blob/master/crash-course.md
+[elements-explained]: https://github.com/compoundjs/guides/blob/master/elements-explained.md
+[routing]: https://github.com/compoundjs/guides/blob/master/routing.md
+[controllers]: https://github.com/compoundjs/guides/blob/master/controllers.md
+[views]: https://github.com/compoundjs/guides/blob/master/views.md
+[helpers]: https://github.com/compoundjs/guides/blob/master/helpers.md
+[mailers]: https://github.com/compoundjs/guides/blob/master/mailers.md
+[security]: https://github.com/compoundjs/guides/blob/master/security.md
+[meta-controllers]: https://github.com/compoundjs/guides/blob/master/meta-controllers.md
+[events-api]: https://github.com/compoundjs/guides/blob/master/events-api.md
+[extensions-api]: https://github.com/compoundjs/guides/blob/master/extensions-api.md
+[deploy]: https://github.com/compoundjs/guides/blob/master/deploy.md
+[testing]: https://github.com/compoundjs/guides/blob/master/testing.md
Please sign in to comment.
Something went wrong with that request. Please try again.