From 04400bdd678ad9d444ad361bb9f77040eaae0775 Mon Sep 17 00:00:00 2001
From: Yessiest <yessiest@memeware.net>
Date: Wed, 20 Sep 2023 00:17:09 +0400
Subject: [PATCH] changed readme to reflect project goals

---
 README.md | 40 ++++++++++++++++++++++++++++++++--------
 1 file changed, 32 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index a1cd62c..f8fe01e 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,31 @@
-# The strange case of Dr. Rack and Mr. Landline
+# Landline - an HTTP DSL
 
-Landline is a library that provides a DSL for creating web applications. As of now it is using Rack as the webserver adapter, but ideally it shouldn't take much work to make it run on top of any webserver.
+Landline is a library that provides a minimalistic DSL for creating
+web services. It doesn't include patterns, middleware, or anything that
+could be considered application logic. It does a few things, and hopefully
+it does them well:
 
-Landline was made mostly for fun. Ideally it will become something more, but as of yet it's just an experiment revolving around Ruby Metaprogramming and its DSL capabilities.
+- Routing HTTP requests to handlers
+- Processing HTTP requests (cookies, headers, etc.)
+- Filtering, preprocessing and postprocessing requests
+- Creating responses from templates using various template engines
+- Parsing and handling forms and queries
+- Connecting multiple Landline applications together
 
-# Examples
+As such, the library is pretty thin and can be used to build more complex
+applications.
+
+As of now it is using Rack as the webserver adapter, but ideally it
+shouldn't take much work to make it run on top of any webserver.
+
+Landline was made mostly for fun. Ideally it will become something more,
+but as of yet it's just an experiment revolving around Ruby Metaprogramming
+and its DSL capabilities.
+
+## Examples
 
 A simple "Hello, World!" app using Landline
+
 ```ruby
 require 'landline'
 
@@ -110,13 +129,18 @@ run app
 
 And a lot more to be found in /examples in this repo.
 
-# Documentation
+## Name
 
-Someday it's gonna be there somewhere
+The name is, quite literally, a metaphor for request routing.
 
-# License
+## Documentation
 
-```
+Documentation can be generated using `yard doc`.
+For things to render correctly, please install the `redcarpet` gem.
+
+## License
+
+```plain
     Landline - an HTTP request pattern matching system 
     Copyright (C) 2022 yessiest (yessiest@memeware.net)