Skip to content

Improve showcase documentation#112

Open
Vladyslav-Kuksiuk wants to merge 6 commits into
masterfrom
improve-showcase-doc
Open

Improve showcase documentation#112
Vladyslav-Kuksiuk wants to merge 6 commits into
masterfrom
improve-showcase-doc

Conversation

@Vladyslav-Kuksiuk

@Vladyslav-Kuksiuk Vladyslav-Kuksiuk commented Jul 10, 2026

Copy link
Copy Markdown
Collaborator

This PR:

  • improves the showcase documentation to make it clearer that the embed-code application is not tied to any specific source code language;
  • adds a Quick Start guide with a minimal working configuration;
  • updates the release workflow to package Linux binaries into archives, preserving their executable permissions.

@codecov

codecov Bot commented Jul 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.19%. Comparing base (9586f2f) to head (327137d).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #112   +/-   ##
=======================================
  Coverage   96.19%   96.19%           
=======================================
  Files          43       43           
  Lines        2945     2945           
=======================================
  Hits         2833     2833           
  Misses         96       96           
  Partials       16       16           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Vladyslav-Kuksiuk Vladyslav-Kuksiuk marked this pull request as ready for review July 10, 2026 13:14

@Oleg-Melnik Oleg-Melnik left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Vladyslav-Kuksiuk See my comment.

Comment thread README.md Outdated
@@ -11,10 +11,17 @@ This project replaces the earlier [`embed-code` utility for Ruby/Jekyll][embed-c

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The top part of the README should contain the following information:

  • a brief description of what the tool does, including all the necessary details;
  • the programming languages it supports;
  • a typical usage example.

The README as a whole should be written for people who are new to the tool.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants