Rename js example app

huggingface · Sep 15, 2023 · 1dcf1c9 · 1dcf1c9
1 parent ef04437
commit 1dcf1c9
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 0 deletions.
diff --git a/examples/vanilla-js/README.md b/examples/vanilla-js/README.md
@@ -0,0 +1,10 @@
+# JavaScript Image Object Detection
+
+This example contains a browser-based JavaScript application that detects objects in images using Transformers.js. The app requires no server, external libraries, or build tools. All you need is a code editor and a browser. 
+
+Here's how it works: the user uploads an image to the browser via the “Upload image” button. The app then downloads an AI model, runs the image through it, and finally displays an overview of where the different objects are located.
+
+To learn more about how the code works, visit [this tutorial.](https://huggingface.co/docs/transformers.js/tutorials/vanilla-js)
+
+## Getting Started
+Download the repo and simply drag and drop the `index.html` file into a browser of your choice.
diff --git a/...es/javascript-object-detection/index.html → examples/vanilla-js/index.html b/...es/javascript-object-detection/index.html → examples/vanilla-js/index.html
diff --git a/...ples/javascript-object-detection/index.js → examples/vanilla-js/index.js b/...ples/javascript-object-detection/index.js → examples/vanilla-js/index.js
diff --git a/...les/javascript-object-detection/style.css → examples/vanilla-js/style.css b/...les/javascript-object-detection/style.css → examples/vanilla-js/style.css