Yessiest
/
landline
1
1
Fork 0
Code Issues 2 Pull Requests Projects 1 Releases Wiki Activity

changed readme to reflect project goals

This commit is contained in:
Yessiest 2023-09-20 00:17:09 +04:00
parent a800faf6e8
commit 04400bdd67
1 changed files with 32 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -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 A simple "Hello, World!" app using Landline
```ruby ```ruby
require 'landline' require 'landline'
@ -110,13 +129,18 @@ run app
And a lot more to be found in /examples in this repo. 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 Landline - an HTTP request pattern matching system
Copyright (C) 2022 yessiest (yessiest@memeware.net) Copyright (C) 2022 yessiest (yessiest@memeware.net)