From 9a248f196a35285b2c1456f9d26462e8babcdde8 Mon Sep 17 00:00:00 2001 From: Rolando Rio <58601896+R0land013@users.noreply.github.com> Date: Wed, 18 Oct 2023 16:12:02 -0400 Subject: [PATCH] Build: Package deployment will occur when pushing a tag to with v** pattern Also, some little changes to README --- .github/workflows/maven.yml | 5 +- README.md | 15 ++++-- pom.xml | 12 +++++ readme_assets/logo.svg | 95 +++++++++++++++++++++++++++++++++++++ 4 files changed, 121 insertions(+), 6 deletions(-) create mode 100644 readme_assets/logo.svg diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml index 52286c8..69583e7 100644 --- a/.github/workflows/maven.yml +++ b/.github/workflows/maven.yml @@ -1,7 +1,10 @@ # This workflow will build a Java project with Maven # For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven name: Java CI with Maven -on: workflow_dispatch +on: + push: + tags: + - v** jobs: build: diff --git a/README.md b/README.md index 44069ec..c6d18a9 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,6 @@ -
- Logo -

Showly

+
+ Logo
## About the project @@ -19,6 +18,7 @@ that serves a web page with a simple web app that displays the slides. - [Maven](https://maven.apache.org/index.html) - [Javalin](https://javalin.io/) - [Apache POI](https://poi.apache.org/) +- [Handlebars.java](https://github.com/jknack/handlebars.java) ## Usage @@ -43,12 +43,17 @@ dependencies { For now, Showly support Power Point binary and xml formats. You can use Showly like this: ```Java +import io.github.r0land013.showly.Showly; +import io.github.r0land013.showly.ShowlyConfig; +import io.github.r0land013.showly.slides.Slide; + + // Create a Showly instance with port and slide file path ShowlyConfig config = new ShowlyConfig(8080, "slides.pptx"); Showly showly = new Showly(config); // Extract slides and start web server -showly.show(); +List slides = showly.show(); // Stop server when done showly.stop(); @@ -66,7 +71,7 @@ But if you want to test locally you can open this in your browser: ## Contribuiting If you wish to contribute with some ideas and bug fixes open an issue describing it. -If you have some great changes to add, please open a Pull Request. +If you have some great changes to add, please, open a Pull Request. ### Running Tests Tests are written with JUnit. To run: diff --git a/pom.xml b/pom.xml index 9d29991..098a711 100644 --- a/pom.xml +++ b/pom.xml @@ -146,6 +146,18 @@ + + + org.sonatype.plugins + nexus-staging-maven-plugin + 1.6.7 + true + + ossrh + https://s01.oss.sonatype.org/ + true + + maven-clean-plugin diff --git a/readme_assets/logo.svg b/readme_assets/logo.svg new file mode 100644 index 0000000..0f66815 --- /dev/null +++ b/readme_assets/logo.svg @@ -0,0 +1,95 @@ + + + + + + + + + + + + + + + + Showly + +