Skip to content

Commit

Permalink
Build: Package deployment will occur when pushing a tag to with v** p…
Browse files Browse the repository at this point in the history
…attern

	Also, some little changes to README
  • Loading branch information
R0land013 committed Oct 18, 2023
1 parent f79148a commit 9a248f1
Show file tree
Hide file tree
Showing 4 changed files with 121 additions and 6 deletions.
5 changes: 4 additions & 1 deletion .github/workflows/maven.yml
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@

<div style="display:flex; flex-direction:row; justify-content:center; align-items:center; align-content:center; justify-items:center; width:100%; background-color:green; border-radius: 15px; padding:2rem;">
<img src="src/main/resources/static/assets/images/logo.svg" alt="Logo" style="height:50px;">
<h1 style="color:white;text-align: center;">Showly</h1>
<div style="display:flex; flex-direction:row; justify-content:center; align-items:center; align-content:center; justify-items:center; width:100%;">
<img src="readme_assets/logo.svg" alt="Logo" style="height:100%; width:100%">
</div>

## About the project
Expand All @@ -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

Expand All @@ -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<Silde> slides = showly.show();

// Stop server when done
showly.stop();
Expand All @@ -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:
Expand Down
12 changes: 12 additions & 0 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,18 @@
<build>
<pluginManagement>
<plugins>

<plugin>
<groupId>org.sonatype.plugins</groupId>
<artifactId>nexus-staging-maven-plugin</artifactId>
<version>1.6.7</version>
<extensions>true</extensions>
<configuration>
<serverId>ossrh</serverId>
<nexusUrl>https://s01.oss.sonatype.org/</nexusUrl>
<autoReleaseAfterClose>true</autoReleaseAfterClose>
</configuration>
</plugin>

<plugin>
<artifactId>maven-clean-plugin</artifactId>
Expand Down
95 changes: 95 additions & 0 deletions readme_assets/logo.svg
Loading
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 9a248f1

Please sign in to comment.