Skip to content

Commit

Permalink
readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
atuttle committed Feb 24, 2021
1 parent 536b2cc commit 3cefedf
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions ReadMe.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,25 @@
[![Build Status](https://travis-ci.org/atuttle/Taffy.svg?branch=master)](https://travis-ci.org/atuttle/Taffy)


You're here because creating REST APIs with the native functionality in ColdFusion 10+, Railo, and Lucee is verbose, complex, and developer-hostile. Or maybe you're still on an older version of ColdFusion.

**You've come to the right place.**
You're here because creating REST APIs with the native functionality in ColdFusion 10+, Railo, and Lucee is verbose, complex, and developer-hostile. Or maybe you're still on an older version of ColdFusion. **You've come to the right place.**

Taffy is low friction, extremely simple to get started, and it's compatible as far back as ColdFusion 8.

It's terse because it uses convention over configuration, and doesn't require writing a bunch of boilerplate code. How terse? [A functional API can fit into a tweet](https://twitter.com/cf_taffy/statuses/327415972581486592).
It's terse because it uses convention over configuration, and doesn't require writing a bunch of boilerplate code. How terse? [A functional API can fit into a tweet](https://twitter.com/taffyio/status/327415972581486592).

It's easy to debug because error messages are returned as JSON by default and it optionally integrates with your favorite IoC libraries like **ColdSpring** and **DI/1**.

## Currently Supported Versions

* Taffy 3.2.x
* Taffy 3.1.x
* Taffy 3.0.x
* Taffy 2.2.x

If you file a bug or ask for support please indicate which version of Taffy you're using. If it's an older release, we usually ask you to upgrade. Officially, we promise to support the current and previous **minor** releases and the last **minor** release of the previous **major** release. To the best of our abilities Taffy follows the versioning guidelines defined in [semver](http://semver.org/).

Supported versions get priority for bug fixes. No promises are made to fix bugs filed against **unsupported** versions. If your version is supported and your bug is reproducible and isolatable, we'll do everything within our power to address it.

If you're on an unsupported version, upgrade is not an option in your case, and you still have an isolatable and reproducible bug, [contact me](http://twitter.com/adamtuttle) to discuss further options.
If you're on an unsupported version, upgrade is not an option in your case, and you still have an isolatable and reproducible bug, [contact me][5] to discuss further options.

## Running the Tests

Expand Down Expand Up @@ -51,13 +49,11 @@ Features and bug fixes are coordinated via the [GitHub issues list](https://gith

## Community

We have [a mailing list for Taffy Users][1]. Feel free to ask for help, discuss potential bugs, and share new ideas there.

You can also find us in the [CFML Slack][4], where there is even a dedicated **#taffy** channel.
The most active place where Taffy users and contributors gather is in the **#taffy** channel of the [CFML Slack][4]. It's a great place to ask for help. We also have [a mailing list][1], but it hasn't been used much since the CFML Slack came around.

## Open Source!
## Need serious help?

Part of the beauty of open source is that _you can affect change_. You can help improve the documentation, fix a bug, add tests, or even propose new features. Nothing is off limits, and I try to be very responsive to pull requests and on the mailing list.
If your problem is too big or too private to ask for help in a chat room, [I am available to hire for freelance work][5].

## LICENSE

Expand All @@ -79,3 +75,4 @@ It means you can use Taffy pretty much any way you like. You can fork it. You ca
[2]:https://github.com/atuttle/TaffyDocs
[3]:http://atuttle.github.com/Taffy/documentation.html
[4]:http://cfml-slack.herokuapp.com
[5]:https://adamtuttle.codes/freelance

0 comments on commit 3cefedf

Please sign in to comment.