bumped version

Project.toml

@@ -2,7 +2,7 @@ name = "Oxygen"
 uuid = "df9a0d86-3283-4920-82dc-4555fc0d1d8b"
 authors = ["Nathan Ortega <[email protected]>"]
 repo = "https://github.com/OxygenFramework/Oxygen.jl.git"
-version = "1.5.13"
+version = "1.5.14"
 
 [deps]
 DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"

README.md

@@ -42,6 +42,7 @@ Need Help? Feel free to reach out on our social media channels.
 - Cron Scheduling (on endpoints & functions)
 - Middleware chaining (at the application, router, and route levels)
 - Static & Dynamic file hosting
+- Hot reloads with Revise.jl
 - Templating Support
 - Plotting Support
 - Protocol Buffer Support
@@ -605,7 +606,7 @@ When the server is ran, all tasks are started automatically. But the module also
 
 ## Hot reloads with Revise
 
-Oxygen can interoperates with Revise to provide hot reloads, speeding up development. Since Revise recommends keeping all code to be revised in a package, you first need to move to this type of a layout.
+Oxygen can integrate with Revise to provide hot reloads, speeding up development. Since Revise recommends keeping all code to be revised in a package, you first need to move to this type of a layout.
 
 [First make sure your `Project.toml` has the required fields such as `name` to work on a package rather than a project.](https://pkgdocs.julialang.org/v1/toml-files/)
 

demo/ProjectBasedDemo/Project.toml

@@ -7,4 +7,4 @@ version = "0.1.0"
 Oxygen = "df9a0d86-3283-4920-82dc-4555fc0d1d8b"
 
 [compat]
-Oxygen = "1.5.13"
+Oxygen = "1"

docs/src/index.md

@@ -42,6 +42,7 @@ Need Help? Feel free to reach out on our social media channels.
 - Cron Scheduling (on endpoints & functions)
 - Middleware chaining (at the application, router, and route levels)
 - Static & Dynamic file hosting
+- Hot reloads with Revise.jl
 - Templating Support
 - Plotting Support
 - Protocol Buffer Support
@@ -603,6 +604,40 @@ end
 
 When the server is ran, all tasks are started automatically. But the module also provides utilities to have more fine-grained control over the running tasks using the following functions: `starttasks()`, `stoptasks()`, and `cleartasks()`
 
+## Hot reloads with Revise
+
+Oxygen can integrate with Revise to provide hot reloads, speeding up development. Since Revise recommends keeping all code to be revised in a package, you first need to move to this type of a layout.
+
+[First make sure your `Project.toml` has the required fields such as `name` to work on a package rather than a project.](https://pkgdocs.julialang.org/v1/toml-files/)
+
+Next, write the main code for you routes in a module `src/MyModule.jl`:
+
+```
+module MyModule
+
+using Oxygen; @oxidise
+
+@get "/greet" function(req::HTTP.Request)
+    return "hello world!"
+end
+
+end
+```
+
+Then you can make a `debug.jl` entrypoint script:
+
+```
+using Revise
+using Oxygen
+using MyModule
+
+MyModule.serve(revise=:eager)
+```
+
+The `revise` option can also be set to `:lazy`, in which case revisions will always be left to just before a request is served, rather than being attempted eagerly when source files change on disk.
+
+Note that you should run another entrypoint script without Revise in production.
+
 ## Multiple Instances
 
 In some advanced scenarios, you might need to spin up multiple web severs within the same module on different ports. Oxygen provides both a static and dynamic way to create multiple instances of a web server.

src/core.jl

@@ -43,7 +43,7 @@ oxygen_title = raw"""
 
 function serverwelcome(external_url::String, docs::Bool, metrics::Bool, parallel::Bool, docspath::String)
     printstyled(oxygen_title, color=:blue, bold=true)
-    @info "📦 Version 1.5.13 (2024-09-02)"
+    @info "📦 Version 1.5.14 (2024-10-17)"
     @info "✅ Started server: $external_url"
     if docs
         @info "📖 Documentation: $external_url" * docspath