Skip to content
Browse files

More edits to the readme

  • Loading branch information...
1 parent 75b45b6 commit e330306c096642e64a9629335d158a6866ef01ec @thecodejunkie thecodejunkie committed
Showing with 27 additions and 15 deletions.
  1. +27 −15 readme.md
View
42 readme.md
@@ -1,34 +1,46 @@
# Meet Nancy
-Nancy is a lightweight HTTP framework for the .Net platform and Mono. The ethos of Nancy is to strive for simplicity and elegance, all features to be easy and ready to use right out-of-the-box.
+Nancy is a lightweight, low-ceremony, framework for building HTTP based services on .Net and [Mono](http://mono-project.com). The goal of the framework is to stay out of the way as much as possible and provide a super-duper-happy-path to all interactions.
-Simplicity means that a feature should requires little or low-ceremony to use, there should always be sensible default configurations, behaviors and conventions available.
+Nancy is designed to handle `DELETE`, `GET`, `HEAD`, `OPTIONS`, `POST`, `PUT` and `PATCH` requests and provides a simple, elegant, [Domain Specific Language (DSL)](http://en.wikipedia.org/wiki/Domain-specific_language) for returning a response with just a couple of keystrokes, leaving you with more time to focus on the important bits..
+**your** code and **your** application.
-The elegance comes from an easy to use and light syntax, combined with letting the framework be responsible for a lot of things that developers should not have to worry about or re-implement in each application you create.
+Write your application
-We call this the super-duper-happy-path.
+ public class Module : NancyModule
+ {
+ public Module()
+ {
+ Get["/greet/{name}"] = x => {
+ return string.Concat("Hello ", x.name);
+ };
+ }
+ }
+
+Compile, run and enjoy the simple, elegant design!
## Features
* Built from the bottom up, not simply a DSL on top of an existing framework. Removing limitations and feature hacks of an underlying framework, as well as the need to reference more assemblies than you need. _keep it light_
* Run anywhere. Nancy is not built on any specific hosting technology can can be run anywhere. Out of the box, Nancy supports running on ASP.NET/IIS, WCF, Self-hosting and any [OWIN](http://owin.org)
-* Ultra lightweight action declarations for GET, HEAD, PUT, POST, DELETE and OPTIONS requests
+* Ultra lightweight action declarations for GET, HEAD, PUT, POST, DELETE, OPTIONS and PATCH requests
* View engine integration (Razor, Spark, NDjango, dotLiquid and our own SuperSimpleViewEngine)
* Powerful request path matching that includes advanced parameter capabilities. The path matching strategy can be replaced with custom implementations to fit your exact needs
* Easy response syntax, enabling you to return things like int, string, HttpStatusCode and Action<Stream> elements without having to explicitly cast or wrap your response - you just return it and Nancy _will_ do the work for you
* A powerful, light-weight, testing framework to help you verify the behavior of your application
-## Usage
+## The super-duper-happy-path
- public class Module : NancyModule
- {
- public Module()
- {
- Get["/greet/{name}"] = x => {
- return string.Concat("Hello ", x.name);
- };
- }
- }
+The "super-duper-happy-path" (or SDHP if you’re ‘down with the kids’ ;-)) is a phrase we coined to describe the ethos of Nancy; and providing the “super-duper-happy-path” experience is something we strive for in all of our APIs.
+
+While it’s hard to pin down exactly what it is, it’s a very emotive term after all, but the basic ideas behind it are:
+
+* “It just works” - you should be able to pick things up and use them without any mucking about. Added a new module? That’s automatically discovered for you. Brought in a new View Engine? All wired up and ready to go without you having to do anything else. Even if you add a new dependency to your module, by default we’ll locate that and inject it for you - no configuration required.
+* “Easily customisable” - even though “it just works”, there shouldn’t be any barriers that get in the way of customisation should you want to work the way you want to work with the components that you want to use. Want to use another container? No problem! Want to tweak the way routes are selected? Go ahead! Through our bootstrapper approach all of these things should be a piece of cake.
+* “Low ceremony” - the amount of “Nancy code” you should need in your application should be minimal. The important part of any Nancy application is your code - our code should get out of your way and let you get on with building awesome applications. As a testament to this it’s actually possible to fit a functional Nancy application into a single Tweet :-)
+* “Low friction” - when building software with Nancy the APIs should help you get where you want to go, rather than getting in your way. Naming should be obvious, required configuration should be minimal, but power and extensibility should still be there when you need it.
+
+Above all, creating an application with Nancy should be a pleasure, and hopefully fun! But without sacrificing the power or extensibility that you may need as your application grows.
## Community

0 comments on commit e330306

Please sign in to comment.
Something went wrong with that request. Please try again.