Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jjlauer committed Nov 4, 2023
1 parent edf6a06 commit bc72df1
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ the JVM. Can replace shell scripts and plays nicely with other tools. Only
requires a Java 8 runtime and adding `blaze.jar` to your project directory. Start
writing portable and cross-platform scripts.

![](docs/blaze-demo.gif)

Blaze pulls together stable, mature libraries from the Java ecosystem into a
light-weight package that lets you focus on getting things done. When you
invoke blaze, it does the following:
Expand All @@ -31,6 +33,14 @@ invoke blaze, it does the following:
- Loads and compiles your script(s)
- Executes "tasks" (methods your script defines)

## What is a blaze script?

A Blaze script is a 100% valid JVM class with public methods that typically uses
an empty (root) package declaration. Each public method becomes the externally
accessible task that can be called from the command-line. Since most JVM languages
support this kind of structure, Blaze can easily support a wide variety of
JVM languages.

## Features

- Write your applications (scripts) in whatever JVM language you prefer.
Expand Down Expand Up @@ -58,14 +68,6 @@ invoke blaze, it does the following:
- [SSH plugin](docs/SSH.md)
- [HTTP plugin](docs/HTTP.md)

## What is a blaze script?

A Blaze script is a 100% valid JVM class with public methods that typically uses
an empty (root) package declaration. Each public method becomes the externally
accessible task that can be called from the command-line. Since most JVM languages
support this kind of structure, Blaze can easily support a wide variety of
JVM languages.

## Try It

To give this project a quick try on your own machine, just run some of the examples:
Expand All @@ -76,8 +78,6 @@ To give this project a quick try on your own machine, just run some of the examp
java -jar blaze.jar examples/natives.java
java -jar blaze.jar examples/find_javas.java

[![asciicast](https://asciinema.org/a/RuvHAKmRQ7Y2kF9qVv7dfGZNt.svg)](https://asciinema.org/a/RuvHAKmRQ7Y2kF9qVv7dfGZNt)

## Install to your project

Download `blaze.jar` to your project directory. If you have `wget` available
Expand Down
Binary file added docs/blaze-demo.gif
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bc72df1

Please sign in to comment.