From 2140dfafc2e16e5b96d5e3a10fc2ea3e4720f8ea Mon Sep 17 00:00:00 2001 From: David Baldwynn Date: Sat, 22 Apr 2017 16:27:06 -0700 Subject: [PATCH] Added table of contents to README --- README.md | 91 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 53 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index 62297675..5905b2ae 100755 --- a/README.md +++ b/README.md @@ -7,10 +7,23 @@ TellForm 2.0.0 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/3491e86eb7194308b8fc80711d736ede)](https://www.codacy.com/app/david-baldwin/tellform?utm_source=github.com&utm_medium=referral&utm_content=whitef0x0/tellform&utm_campaign=Badge_Grade) [![Gitter](https://badges.gitter.im/whitef0x0/tellform.svg)](https://gitter.im/whitef0x0/tellform?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) -TellForm is an *opensource alternative to TypeForm* built ontop of NodeJS that can create [stunning mobile-ready forms](https://tellform.com/examples) , surveys and questionnaires. +> An *opensource alternative to TypeForm* that can create [stunning mobile-ready forms](https://tellform.com/examples) , surveys and questionnaires. [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/whitef0x0/tellform/tree/master) +## Table of Contents + +- [Features](#features) +- [How to Contribute](#how-to-contribute) +- [Quickstart](#quickstart) +- [Deploying with Docker](#deploying-with-docker) +- [Testing your Application](#testing-your-application) +- [Where to Get Help](#where-to-get-help) +- [Sponsors](#sponsors) +- [Backers](#backers) +- [Contributors](#contributors) +- [Mentions on the Web](#mentions-on-the-web) + ## Features ### Currently following features are implemented: @@ -34,7 +47,9 @@ TellForm is an *opensource alternative to TypeForm* built ontop of NodeJS that c - Add Custom Background and Dropdown Field Images - Add File Upload Form Field -### Contributing +### How to Contribute + +Please checkout our CONTRIBUTING.md on ways to contribute to TellForm. All contributors are eligible to get a free [TellForm Sticker](https://www.stickermule.com/marketplace/15987-tellform-round-sticker). All you have to do is submit a PR, get it accepted, email your address to polydaic [at] gmail.com and we'll send you a sticker that you can proudly put on your laptop. @@ -107,40 +122,9 @@ $ docker run --rm -p 3000:3000 --link some-redis:redis-db --link some-mongo:db t -p 80:80 \ ``` -## Sponsors - -Does your company use TellForm? Help keep the project bug-free and feature rich by [sponsoring the project](https://opencollective.com/tellform#sponsor). - - - - - - - - - - - - - - - - - - - - - - -## Backers - -Love our work and community? [Become a backer](https://opencollective.com/tellform). - - ## Testing Your Application -You can run the full test suite included with MEAN.JS with the test task: +You can run the full test suite included with TellForm with the test task: ``` $ grunt test @@ -177,13 +161,47 @@ To calculate your client-side test coverage with Istanbul, run the coverage task $ grunt coverage:client ``` + ## Where to get help [Gitter Chat](https://gitter.im/whitef0x0/tellform) [Official Twitter](https://twitter.com/tellform_real) -## Contributor list + +## Sponsors + +Does your company use TellForm? Help keep the project bug-free and feature rich by [sponsoring the project](https://opencollective.com/tellform#sponsor). + + + + + + + + + + + + + + + + + + + + + + +## Backers + +Love our work and community? [Become a backer](https://opencollective.com/tellform). + + + +## Contributors [David Baldwynn](https://github.com/whitef0x0/) @@ -208,6 +226,3 @@ $ grunt coverage:client [Betapage](https://betapage.co/startup/tellform) [Opensource.com](http://opensource.com/article/17/2/tools-online-surveys-polls) - -## Credits -Inspired/built off the great work of the [MeanJS team](https://github.com/meanjs/) and [Typeform](http://typeform.com)