Skip to content

Commit 2db8e30

Browse files
committed
Add readme
1 parent 49b90f0 commit 2db8e30

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

readme.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
![Weaver logo](https://modula.dev/weaver.png)
2+
# Weaver
3+
A simple library for quick websites
4+
5+
## License
6+
This project is made available by Modula under the
7+
[AGPLv3](https://www.gnu.org/licenses/agpl-3.0.html).
8+
For more information, see the [license page](https://modula.dev/weaver/license),
9+
or check out the [Wikipedia Summary](https://en.wikipedia.org/wiki/GNU_Affero_General_Public_License)
10+
11+
<a href="https://www.gnu.org/licenses/agpl-3.0.html"><img src="https://www.gnu.org/graphics/agplv3-with-text-162x68.png"/></a>
12+
13+
## Installation
14+
Just save (or copy) [this source file](https://modula.dev/weaver.js)
15+
to your project's working directory
16+
17+
## Usage
18+
Using Weaver to begin serving a JavaScript site is a short-few simple steps.
19+
Copy the Weaver source code into your project's directory, `import` it,
20+
initialize the `weaver.router`, add some file paths or functions as routes,
21+
and then hand-off control by calling `weaver.serve` at the end.
22+
23+
[Click here to download the full Weaver documentation](https://modula.dev/weaver.pdf)
24+
</div>
25+
26+
<footer>
27+
<a href="https://modula.dev">Modula.dev</a><br>
28+
Modula / Blood Rose Records © 2022-2024
29+
</footer>

0 commit comments

Comments
 (0)