From 7ed4ecf69a912c76fd51d708b315bb53792a3970 Mon Sep 17 00:00:00 2001 From: vjc22 <73601189+vjc22@users.noreply.github.com> Date: Sun, 12 Feb 2023 17:01:50 -0500 Subject: [PATCH 1/3] Update README.md Added overview section. Added getting started section and a tutorial. Added benefits section. Added documentation section. Added contributing section. --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 47 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d2f540cf..6e1ebbca 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,59 @@ + +# MochiWeb MochiWeb is an Erlang library for building lightweight HTTP servers. -The latest version of MochiWeb is available at https://github.com/mochi/mochiweb +## Overview +MochiWeb provides a lightweight and fast solution for building HTTP servers in Erlang. The library is designed to be easy to use and provides a comprehensive set of features for building robust and scalable HTTP servers. + +## Getting Started +Before you can use MochiWeb, you'll need to have [Erlang OTP](https://www.erlang.org/) installed. Once you have Erlang OTP installed, you can download the latest version of MochiWeb from the [GitHub repository](https://github.com/mochi/mochiweb). + +For a MochiWeb project, first obtain a copy of MochiWeb using Git by running the command. + + +```erlang-repl +$ git clone git://github.com/mochi/mochiweb.git. +``` +To create a project. + +```erlang-repl +$ cd mochiweb +$ make app PROJECT=exampleName +``` + +You can now start the project with. -The mailing list for MochiWeb is at https://groups.google.com/group/mochiweb/ +```erlang-repl +$ cd ../exampleName/ +$ make +$ ./start-dev.sh +``` -Erlang OTP is required for setting up the MochiWeb environment and is available at https://www.erlang.org/ +You can access the app by navigating to http://localhost:8080 in your browser. -To create a new mochiweb using project see the `example_project` in the `examples/` folder. +For an example, view the `example_project` in the `examples/` folder. -Information about Rebar (Erlang build tool) is available at https://github.com/erlang/rebar3 -MochiWeb is currently tested with Erlang/OTP 18.3 through 25.1.1, -versions older than 3.0.0 may still be compatible back to R15B-03. +## Benefits +* Lightweight: MochiWeb is designed to be lightweight and fast, making it ideal for use in resource-constrained environments. -# OTP 21.2, 21.2.1, 21.2.2 warning +* Easy to use: MochiWeb provides a simple and intuitive API that makes it easy to get started with building HTTP servers. + +* Robust: MochiWeb provides a comprehensive set of features for building robust and scalable HTTP servers. + +## Documentations and Resources +[MochiWeb API documentation](https://github.com/mochi/mochiweb/blob/main/examples/hmac_api/README) + +[Information about Rebar (Erlang build tool)](https://github.com/erlang/rebar3) + +[Mailing list](https://groups.google.com/group/mochiweb/) + +## OTP 21.2, 21.2.1, 21.2.2 warning OTP 21.2 (up to and including 21.2.2) introduced an SSL regression that makes these releases unsafe to use. See [ERL-830](https://bugs.erlang.org/browse/ERL-830). This issue was resolved in OTP 21.2.3. + + +## Contributing +MochiWeb is an open-source project and welcomes contributions from the community. From 125d080e40c1ec61d9ca792bc8ca522bfb93e6cf Mon Sep 17 00:00:00 2001 From: vjc22 <73601189+vjc22@users.noreply.github.com> Date: Sun, 12 Feb 2023 17:46:35 -0500 Subject: [PATCH 2/3] Update README.md Updated with the suggested changes --- README.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/README.md b/README.md index 6e1ebbca..ee112af3 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,8 @@ - # MochiWeb MochiWeb is an Erlang library for building lightweight HTTP servers. ## Overview -MochiWeb provides a lightweight and fast solution for building HTTP servers in Erlang. The library is designed to be easy to use and provides a comprehensive set of features for building robust and scalable HTTP servers. +MochiWeb provides a lightweight and fast solution for building HTTP servers in Erlang. The library is provides features for building robust and scalable HTTP servers. ## Getting Started Before you can use MochiWeb, you'll need to have [Erlang OTP](https://www.erlang.org/) installed. Once you have Erlang OTP installed, you can download the latest version of MochiWeb from the [GitHub repository](https://github.com/mochi/mochiweb). @@ -42,8 +41,6 @@ For an example, view the `example_project` in the `examples/` folder. * Robust: MochiWeb provides a comprehensive set of features for building robust and scalable HTTP servers. ## Documentations and Resources -[MochiWeb API documentation](https://github.com/mochi/mochiweb/blob/main/examples/hmac_api/README) - [Information about Rebar (Erlang build tool)](https://github.com/erlang/rebar3) [Mailing list](https://groups.google.com/group/mochiweb/) From eaba29ba3ef5c2519908852c47d44dff562fc63b Mon Sep 17 00:00:00 2001 From: vjc22 <73601189+vjc22@users.noreply.github.com> Date: Sun, 12 Feb 2023 17:48:51 -0500 Subject: [PATCH 3/3] Update README.md Fixed typo in line 5. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ee112af3..206e4049 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ MochiWeb is an Erlang library for building lightweight HTTP servers. ## Overview -MochiWeb provides a lightweight and fast solution for building HTTP servers in Erlang. The library is provides features for building robust and scalable HTTP servers. +MochiWeb provides a lightweight and fast solution for building HTTP servers in Erlang. The library provides features for building robust and scalable HTTP servers. ## Getting Started Before you can use MochiWeb, you'll need to have [Erlang OTP](https://www.erlang.org/) installed. Once you have Erlang OTP installed, you can download the latest version of MochiWeb from the [GitHub repository](https://github.com/mochi/mochiweb).