Skip to content
Browse files

updating docs

  • Loading branch information...
1 parent f6c41f5 commit b9c8a8db561da610d089f27ae62b411f61eeb4d3 @Marak Marak committed
Showing with 12 additions and 6 deletions.
  1. +12 −6 README.md
View
18 README.md
@@ -1,13 +1,13 @@
-# Nuptials - Generate vows code through natural language.
+# Nuptials
-Nuptials is a node client facing app for managing and creating vows test steps through natural language via cucumber.
+## A project planning tool that allows you to meaningfully engage your clients and convert their domain knowledge into tangible milestones, features, scenarions, and unit tests.
-Cucumber works via plain text descriptions of how your software should work.
-Learn more about [Cucumber](http://cukes.info/).
+## Features
-Think testing business logic with all the tastiness of organizing via easily readable steps.
+- Scenarios are created using Kyuri, a custom dialect of Gherkin geared towards asyncrounsous programming
+- Heavily influenced by Cucumber. If you know Cuke, you know Nuptials.
+- Generates VowsJS testing stubs (VowsJS is a well established node.js testing framework)
-## Features
### Features and Scenarios
* Easily create order and delete features from your project with a click of a button
@@ -30,3 +30,9 @@ Heavily inspired by Sean Cribbs' [Lowdownapp](http://lowdownapp.com/)
#### Technologies/Projects used
* [Kyuri](http://github.com/nodejitsu/kyuri)
+
+
+Cucumber works via plain text descriptions of how your software should work.
+Learn more about [Cucumber](http://cukes.info/).
+
+Think testing business logic with all the tastiness of organizing via easily readable steps.

0 comments on commit b9c8a8d

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