Skip to content

Commit

Permalink
Remove the autoreloader executable
Browse files Browse the repository at this point in the history
The executable does not seem able to watch the file while executing
another command. More work needs to be done in order to get this
working. This change temporarily removes that functionality.
  • Loading branch information
agschwender committed Nov 18, 2022
1 parent e854d1c commit ca07d44
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 47 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,26 @@

# autoreload

`autoreload` provides a package and a command for automatically reloading an executable when that executable changes. It intended to be used in a local development environment to reload the executable after it has been modified as part of the development process. An example use case, would be to reload a go web app after you have edit the source code and recompiled the executable.
`autoreload` provides a package for automatically reloading an executable when that executable changes. It intended to be used in a local development environment to reload the executable after it has been modified as part of the development process. An example use case, would be to reload a go web app after you have edit the source code and recompiled the executable.

## Installation

`autoreload` can be used as either a package that is integrated into your application or as an executable that you run your application with. To use the package, add the following to your application:
`autoreload` can be used as a package that is integrated into your application:

```
autoreload.New().Start()
```
package main
See the [provided example](https://github.com/agschwender/autoreload/blob/main/example/main.go) for greater detail on how to integrate the package into your application.
import (
"github.com/agschwender/autoreload"
)
To use the executable, you must first install it
func main() {
// Application setup
autoreload.New().Start()
// Application run and waiting
}
```
go install github.com/agschwender/autoreload/autoreloader@v1.0.0
```

You can then execute it by running the following

```
autoreloader my-application -v -a --arg
```
See the [provided example](https://github.com/agschwender/autoreload/blob/main/example/main.go) for greater detail on how to integrate the package into your application.
34 changes: 0 additions & 34 deletions autoreloader/main.go

This file was deleted.

0 comments on commit ca07d44

Please sign in to comment.