Implementation to README

README.md

@@ -1,52 +1,23 @@
 # Fractalinator
 
-UPDATE 11/24/24: Fractalinator is now available in modern web browsers at [https://fcseidl.github.io/fractalinator/](https://fcseidl.github.io/fractalinator/). Try it!
+This repo holds the source code from a digital art demo I created and deployed as a single-page web application. To use the app to make your own art, click [here](https://fcseidl.github.io/fractalinator/). Read on to learn more about the idea and its implementation.
 
-This is an drawing app which lets you draw a [multibrot](https://en.wikipedia.org/wiki/Multibrot_set)-like fractal in any shape that you choose! For instance, the video below shows me drawing in a pop-up window opened by the following simple program. I tried to evoke a saguaro cactus. A few more example fractalinations are at the bottom of this README.
-```
-from fractalinator import App
-App(cmap_name='viridis_r', power=3)
-```
+This is an drawing app which lets you draw a [multibrot](https://en.wikipedia.org/wiki/Multibrot_set)-like fractal in any shape that you choose! The video below shows an example. I tried to evoke a saguaro cactus. A few more example fractalinations are at the bottom of this README.
 
 
 https://github.com/user-attachments/assets/bca13855-29b0-4c92-9ce6-bf94ea0d238d
 
 
 
 
-## Installation
-Install ```fractalinator``` by running the command 
+## Implementation
+Your browser runs the fractalinator app using the four files in the ```/docs``` folder. Three of these are the usual `index.html`, with a CSS stylesheet and a javascript which handles the interactivity. The fourth is a wheel for the ```fractalinator``` Python package, built from source code in this repository. This package controls the fractal image, performing numerical computation which would be slow and cumbersome in Javascript. Python methods are called from Javascript using [pyodide](https://pyodide.org/en/stable/index.html), a WASM Python interpreter.
+
+You can also install the fractalinator package to your Python environment using 
 ```
 pip install git+https://github.com/fcseidl/fractalinator/
 ```
-or by cloning this repo.
-
-## Dependencies
-To make Fractalinator easy to play with, it has few dependencies. The ```pip``` command above installs ```numpy``` and ```matplotlib``` automatically, if they are not installed already. ```tkinter``` is usually installed by default with Python.
-| Library    | Tested Version |
-| -------- | ------- |
-| numpy  | 2.1.0    |
-| matplotlib | 3.9.2     |
-| tkinter | 8.6 |
-
-## Usage
-Fractalinator drawing windows are managed by the ```App``` class. To make a fractalination, simply construct an ```App``` object. 
-Calling ```App()``` will open a drawing window with the default settings. To save your drawing, press the 1 key while in the drawing window. 
-Your art will be saved to a file named ```fractalination-[n].png```. Other number keys (2-5) behave similarly, but save a more detailed image with the resolution multiplied by the number on the key.
-
-The default settings can be changed with a number of keyword arguments. Mostly notably, the ```cmap_name``` argument allows you to choose any [matplotlib colormap](https://matplotlib.org/stable/gallery/color/colormap_reference.html). The full set of keyword arguments is described below.
-| **Name** | **Default** | **Description** |
-| -------- | ----------- | --------------- |
-| ```bailout_radius``` | ```5.0``` | Escape threshold for iterative fractal generation. Values near or below 2.0 may allow the noise field to affect the background image. |
-| ```brush_radius``` | ```100``` | Size of the "brush" you draw with. Larger values slow drawing. |
-| ```cmap_name``` | ```"gray_r"``` | ```matplotlib``` colormap name to use in image. |
-| ```cmap_period``` | ```8.0``` | Smaller values make the colormap repeat more frequently around the outside of the fractal.|
-| ```max_it``` | ```30``` | Maximum iteration count for iterative fractal generation. Smaller values speed computation but reduce image quality. |
-| ```noise_seed``` | ```None``` | If positive integer, random seed for reproducible noise. |
-| ```noise_sig``` | ```26.0``` | Smaller values result in more, smaller features in the image. |
-| ```power``` | ```2``` | Multibrot fractal order. Must be a positive integer. |
-| ```shape``` | ```(720, 576)``` | (width, height) of drawing window in pixels. Note that large windows may exhibit perceptible lag when drawing. |
-| ```thin_it``` | ```5``` | Only iterate pixels to ```max_it``` if they are not diverged by this iteration, saving computation costs. |
+If your environment has Tkinter configured, you can run the `demo.py` module to open a fractalinator canvas in a separate window, outside the browser.
 
 ## Is the name a *Phineas and Ferb* reference?
 Yes, yes it is.