feat: update

README.md

@@ -1,13 +1,14 @@
 # earendel
 
-Tiny microservice framework with flexible.
+Simple caching server for DevOps.
 
-This is a microservice framework using Node.js + express.js,
-provides the tree to write your service with a tidy and clear structure of project.
+The server provides a simple API for caching data like text or binary files.
 
-The framework is recommended to be used on light payload tasks.
+## Installation
 
-![lavateinn](logo.png)
+```shell
+npm install
+```
 
 ## Development
 
@@ -25,3 +26,35 @@ Start the service for providing to our dear clients!
 ```shell
 npm start
 ```
+
+## API
+
+### GET /token
+
+Generate a new token. The token is a [nanoid](https://www.npmjs.com/package/nanoid).
+
+Every token is unique, and it is used to identify the content in the cache.
+
+### GET /text/:token
+
+Get the text content from the cache.
+
+### POST /text/:token
+
+Save the text content to the cache.
+
+### DELETE /text/:token
+
+Delete the text content from the cache.
+
+### GET /file/:token
+
+Get the file content from the cache.
+
+### POST /file/:token
+
+Save the file content to the cache.
+
+### DELETE /file/:token
+
+Delete the file content from the cache.

app.mjs

@@ -22,7 +22,6 @@ const pluginPromises = [];
 // Define router names
 const routerNames = [
     "root",
-    "session",
     "text",
     "file",
 ];

src/routes/root.mjs

@@ -7,6 +7,10 @@ import {
     useApp,
 } from "../init/express.mjs";
 
+import {
+    nanoid,
+} from "nanoid";
+
 // Export routes mapper (function)
 export default () => {
     // Use application
@@ -15,14 +19,19 @@ export default () => {
     // API Index Message
     app.get("/", (_, res) => {
         const meetMessage = `
-        Star Inc. Lavateinn Framework <br />
-        <a href="https://github.com/star-inc/lavateinn" target="_blank">
-            https://github.com/star-inc/lavateinn
+        earendel <br />
+        <a href="https://github.com/star-inc/earendel" target="_blank">
+            https://github.com/star-inc/earendel
         </a>
         `;
         res.status(StatusCodes.IM_A_TEAPOT).send(meetMessage);
     });
 
+    // Get the token
+    app.get("/token", (_, res) => {
+        res.send(nanoid());
+    });
+
     // The handler for robots.txt (deny all friendly robots)
     app.get("/robots.txt", (_, res) => {
         res.type("txt").send("User-agent: *\nDisallow: /");

src/utils/visitor.mjs

@@ -1,4 +1,4 @@
-// The simple toolbox for fetch visitor information from HTTP request.
+// The simple toolbox for fetching visitor information from HTTP request.
 
 /**
  * Get IP Address.