1
Fork 0

Revert readme changes I have imported from the wrong place

This commit is contained in:
prescientmoon 2024-05-28 03:35:22 +02:00
parent 2dbc7a3a4c
commit 8bb0c4fd2f
Signed by: prescientmoon
SSH key fingerprint: SHA256:UUF9JT2s8Xfyv76b8ZuVL7XrmimH4o49p4b+iexbVH4
5 changed files with 36 additions and 17 deletions
typescript/translucid

View file

@ -1,33 +1,41 @@
# 🚧 This repo has been moved to [prescientmoon/Translucid](https://github.com/prescientmoon/Translucid) 🚧
# Translucid
A simple node.js library to bind files to requests
# Get started:
First you need to install the package:
```
npm install translucid --save
```
Then, you need to include it in your project:
```
const trans = require("translucid");
```
To create your first server, call ".QuickServer(port)":
```
trans.QuickServer(8000);
```
The ".QuickServer" method return many useful objects:
```
const {app,server,connect,translucid} = trans.QuickServer(8000);
```
The translucid object can be used to make file bindings:
```
translucid.bind("/","client/index.html",["myId"]);
```
Then you can add middleware like this:
```
translucid.use({
name:"my middleware",
@ -38,17 +46,20 @@ translucid.use({
});
```
You can make a folder public like this:
```
translucid.public(`client`);
```
You can read bindings from a file:
```
translucid.bindJSON(`data/files.json`);
```
And in files.json:
```
{
"/articles":{
@ -66,12 +77,14 @@ And in files.json:
}
```
The QuickServer returns:
* translucid => the basic translucid object
* express => the express module
* http => the http module
* server => instance of http.Server()
* connect => a promise that resolves when the server is listening to the specified port
The QuickServer returns:
Other utilities in translucid:
* read => read a file
- translucid => the basic translucid object
- express => the express module
- http => the http module
- server => instance of http.Server()
- connect => a promise that resolves when the server is listening to the specified port
Other utilities in translucid:
- read => read a file