From 8bb0c4fd2f4b5dc1e17265ede32d513521e7aa2e Mon Sep 17 00:00:00 2001 From: prescientmoon Date: Tue, 28 May 2024 03:35:22 +0200 Subject: [PATCH] Revert readme changes I have imported from the wrong place --- javascript/mongy/README.md | 12 +++++++++-- javascript/quizizz-hack/README.md | 1 - javascript/ultra32/README.md | 5 +++-- typescript/fourjs/README.md | 2 -- typescript/translucid/README.md | 33 +++++++++++++++++++++---------- 5 files changed, 36 insertions(+), 17 deletions(-) delete mode 100644 javascript/quizizz-hack/README.md delete mode 100644 typescript/fourjs/README.md diff --git a/javascript/mongy/README.md b/javascript/mongy/README.md index 4df4369..055fb82 100644 --- a/javascript/mongy/README.md +++ b/javascript/mongy/README.md @@ -1,30 +1,35 @@ -# 🚧 This repo has been moved to [prescientmoon/Mongy](https://github.com/prescientmoon/Mongy) 🚧 # Mongy -A high level interface for MongoDB built on top of Mongoose +A high level interface for MongoDB built on top of Mongoose #Get started: To get started, first install the package: + ``` npm install mongy ``` + Then you need to include it in your script: + ``` const Mongy = require("mongy"); ``` The next step is to create an instance of the Mongy class: + ``` const mydb = new Mongy(); ``` To connect to your datebase you need to call the 'connect' method: + ``` mydb.connect(process.env.DBURL); ``` To create your first model call createModel(name,collection,schema): + ``` mydb.createModel("User","users",{ name:String, @@ -33,6 +38,7 @@ mydb.createModel("User","users",{ ``` To make an instance of the model call 'instantiate(name,data)': + ``` async function addUser(name,email){ const myNewUser = mydb.instantiate("User",{name,email}); @@ -40,6 +46,7 @@ async function addUser(name,email){ ``` And then to save your model call the function 'saveModel': + ``` async function addUser(name,email){ ... @@ -48,6 +55,7 @@ async function addUser(name,email){ ``` Then you can get the data of your user via the '.find(name,data)' method: + ``` async function getUsers(name){ return await mydb.find("User",{name}); diff --git a/javascript/quizizz-hack/README.md b/javascript/quizizz-hack/README.md deleted file mode 100644 index 4250ae2..0000000 --- a/javascript/quizizz-hack/README.md +++ /dev/null @@ -1 +0,0 @@ -# 🚧 This repo has been moved to [prescientmoon/quizz-hack](https://github.com/prescientmoon/quizz-hack) 🚧 diff --git a/javascript/ultra32/README.md b/javascript/ultra32/README.md index 9d22e89..161090e 100644 --- a/javascript/ultra32/README.md +++ b/javascript/ultra32/README.md @@ -1,11 +1,11 @@ -# 🚧 This repo has been moved to [prescientmoon/ultra32](https://github.com/prescientmoon/ultra32) 🚧 # Ultra32 -A vector package using the fast float32array +A vector package using the fast float32array # Get started: To get started, install ultra32: + ``` npm install ultra32 --save ``` @@ -17,6 +17,7 @@ const vec = new Float32Array([0,0]); ``` You can perform multiple operations: + ``` add(vec,new Float32Array([1,2])); mul(vec,3); diff --git a/typescript/fourjs/README.md b/typescript/fourjs/README.md deleted file mode 100644 index 168c26c..0000000 --- a/typescript/fourjs/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# 🚧 This repo has been moved to [prescientmoon/Four.js](https://github.com/prescientmoon/Four.js) 🚧 -# Four.js \ No newline at end of file diff --git a/typescript/translucid/README.md b/typescript/translucid/README.md index fdfb850..1cc828b 100644 --- a/typescript/translucid/README.md +++ b/typescript/translucid/README.md @@ -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