-
Notifications
You must be signed in to change notification settings - Fork 473
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #254 from vjc22/patch-1
Update README.md
- Loading branch information
Showing
1 changed file
with
44 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,20 +1,56 @@ | ||
# 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 provides features for building robust and scalable HTTP servers. | ||
|
||
The mailing list for MochiWeb is at https://groups.google.com/group/mochiweb/ | ||
## 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). | ||
|
||
Erlang OTP is required for setting up the MochiWeb environment and is available at https://www.erlang.org/ | ||
For a MochiWeb project, first obtain a copy of MochiWeb using Git by running the command. | ||
|
||
To create a new mochiweb using project see the `example_project` in the `examples/` folder. | ||
|
||
Information about Rebar (Erlang build tool) is available at https://github.com/erlang/rebar3 | ||
```erlang-repl | ||
$ git clone git://github.com/mochi/mochiweb.git. | ||
``` | ||
To create a project. | ||
|
||
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. | ||
```erlang-repl | ||
$ cd mochiweb | ||
$ make app PROJECT=exampleName | ||
``` | ||
|
||
# OTP 21.2, 21.2.1, 21.2.2 warning | ||
You can now start the project with. | ||
|
||
```erlang-repl | ||
$ cd ../exampleName/ | ||
$ make | ||
$ ./start-dev.sh | ||
``` | ||
|
||
You can access the app by navigating to http://localhost:8080 in your browser. | ||
|
||
For an example, view the `example_project` in the `examples/` folder. | ||
|
||
|
||
## Benefits | ||
* Lightweight: MochiWeb is designed to be lightweight and fast, making it ideal for use in resource-constrained environments. | ||
|
||
* 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 | ||
[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. |