From ba02d524b7fc0930540d48dde970c762132743ff Mon Sep 17 00:00:00 2001 From: Scott Offen <3513626+scottoffen@users.noreply.github.com> Date: Thu, 31 Dec 2020 21:40:08 -0700 Subject: [PATCH] Updates docs (#218) --- README.md | 8 +++++++- ROADMAP.md | 34 ---------------------------------- SUPPORT.md | 16 ++-------------- 3 files changed, 9 insertions(+), 49 deletions(-) delete mode 100644 ROADMAP.md diff --git a/README.md b/README.md index e3b4ca6..c191241 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ +

+ Grapevine 4 is in maintenence mode
Please migrate to Grapevine 5 +

+ + ![](https://raw.githubusercontent.com/sukona/Grapevine/master/img/grapevine.png) [![Join the chat at https://gitter.im/sukona/Grapevine](https://badges.gitter.im/sukona/Grapevine.svg)](https://gitter.im/sukona/Grapevine?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) @@ -5,7 +10,8 @@ *The best solutions are the simplest to implement*. Embedding a REST/HTTP server in your application should be **simple**. Consuming REST resources from inside your application should be **simple**. If what you've been using *doesn't feel simple*, try **Grapevine**. It doesn't get any simpler than this. -> I'm **always** open to [flattry](https://flattr.com/submit/auto?fid=x79jw7&url=https%3A%2F%2Fgithub.com%2Fsukona%2FGrapevine) +>**Important**:
+>No additional features or enhancements are being made. Bug fixes will be considered on a case-by-case basis. ### Introduction ### diff --git a/ROADMAP.md b/ROADMAP.md deleted file mode 100644 index bc3e8f9..0000000 --- a/ROADMAP.md +++ /dev/null @@ -1,34 +0,0 @@ -Project Roadmap -================= - -**Grapevine 4** introduces a router and a routing table, allowing multiple methods to handle incoming requests in the order that the methods were registered with the router - very much inspired by Express. This will make things like authentication (and other middleware) very easy to create and use. - -### Version 4.0 ### -total test coverage -updated routing -extensibility -payload parsing -server events -routing events -logging -debugging -manual route registration -port management - -### Version 4.0.5 ### - -Support multiple versions of .NET - -### Version 4.1 ### - -resource files as static content -global headers -cors support (other owasp) -multiple public folders -custom error response by status code -integrated windows firewall open/close - -### Version 4.2 ### - -content negotiation -routes w/o parameterless constructors diff --git a/SUPPORT.md b/SUPPORT.md index b064e1d..25eef0b 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -1,7 +1,7 @@ Grapevine Support ================= -Unfortunately, I don't have the time to personally respond to every support request I receive for the open source software I publish. [sadface] Fortunately, I haven't received very many such requests - fortunate because that means Grapevine is easy to understand and intuitive to use! If you do find yourself in need of some support, here are several free options, and one not-so-free option. +If you do find yourself in need of some support, here are several options. ### [Refer To The Documentation](https://github.com/scottoffen/Grapevine/wiki) ### @@ -11,7 +11,7 @@ In addition to class level documentation, the [project wiki](https://github.com/ **For 4.x** -See the [new project website](https://sukona.github.io/Grapevine/), hosted by github.io! +See the [new project website](https://sukona.github.io/Grapevine/). ### [Ask The Community For Help](http://stackoverflow.com/questions/tagged/grapevine?sort=newest) ### @@ -32,15 +32,3 @@ If you have a great idea for an enhancement, but don't know how to implement it, Whether you're contributing code or just an idea, providing a clear and detailed use case and usage examples is going to be paramount in deciding if and when your contribution makes it into the core library. Depending on our availability, sometimes pull requests will sit in the queue until we can get around to reviewing them and merging them into the master branch. I appreciate your patience with my time as I endeavor to ensure that Grapevine remains a stable, high-quality and reliable solution. - -### Geek For Hire ### - -> Let me be **very clear** about this: I did not create Grapevine and offer it as open source with the intention of making money off of it, nor am I making this suggestion in an *ex post facto* attempt to monetize. Not that I'd turn down the opportunity to benefit from my hard work here, but I'd be just fine if this option were never exercised. That being said... - -**If you'd like to pay** for my time and expenses to: - -- Provide consulting services on your project -- Train your team on REST and/or Grapevine -- Give higher priority to your support requests - -Then you should [contact me directly](mailto:github@scottoffen.com) with your request, project time-frame and a description of the problem you'd like me to solve, and I'll respond to you with my availability and an estimate on a first-come-first-serve basis.