[PR #1898] [MERGED] [IMPROVEMENT] Improve documentation clarity and usage example #2686

New Issue

claunia · 2026-01-29T17:23:25Z

claunia commented

2026-01-29 17:23:25 +00:00

📋 Pull Request Information

Original PR: https://github.com/CCExtractor/ccextractor/pull/1898
Author: @hridyasadanand
Created: 12/25/2025
Status: ✅ Merged
Merged: 12/29/2025
Merged by: @cfsmp3

Base: master ← Head: docs-remove-travis-badge

📝 Commits (2)

c2c589d docs: remove outdated Travis CI badge from README
857a3bc docs: add basic usage example to documentation

📊 Changes

2 files changed (+8 additions, -1 deletions)

View changed files

📝 README.md (+0 -1)
📝 docs/README.md (+8 -0)

📄 Description

In raising this pull request, I confirm the following (please check boxes):

I have read and understood the contributors guide.
I have checked that another pull request for this purpose does not exist.
I have considered, and confirmed that this submission will be valuable to others.
I accept that this submission may not be used, and the pull request closed at the will of the maintainer.
I give this submission freely, and claim no ownership to its content.
I have mentioned this change in the changelog.

My familiarity with the project is as follows (check one):

I have used CCExtractor just a couple of times.

This pull request improves documentation clarity by:

Removing an outdated Travis CI build badge from the README.
Adding a simple command-line usage example to the documentation to help new users understand how to run CCExtractor.

These changes aim to reduce confusion for first-time users and contributors by keeping documentation accurate and more beginner-friendly.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/CCExtractor/ccextractor/pull/1898 **Author:** [@hridyasadanand](https://github.com/hridyasadanand) **Created:** 12/25/2025 **Status:** ✅ Merged **Merged:** 12/29/2025 **Merged by:** [@cfsmp3](https://github.com/cfsmp3) **Base:** `master` ← **Head:** `docs-remove-travis-badge` --- ### 📝 Commits (2) - [`c2c589d`](https://github.com/CCExtractor/ccextractor/commit/c2c589d6f67411155143b7e4bb0a61f17f74428c) docs: remove outdated Travis CI badge from README - [`857a3bc`](https://github.com/CCExtractor/ccextractor/commit/857a3bc9c666a8fb8732f40cd77dd5bda4cef967) docs: add basic usage example to documentation ### 📊 Changes **2 files changed** (+8 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+0 -1) 📝 `docs/README.md` (+8 -0) </details> ### 📄 Description **In raising this pull request, I confirm the following (please check boxes):** - [x] I have read and understood the contributors guide. - [x] I have checked that another pull request for this purpose does not exist. - [x] I have considered, and confirmed that this submission will be valuable to others. - [x] I accept that this submission may not be used, and the pull request closed at the will of the maintainer. - [x] I give this submission freely, and claim no ownership to its content. - [ ] I have mentioned this change in the changelog. **My familiarity with the project is as follows (check one):** - [x] I have used CCExtractor just a couple of times. --- This pull request improves documentation clarity by: - Removing an outdated Travis CI build badge from the README. - Adding a simple command-line usage example to the documentation to help new users understand how to run CCExtractor. These changes aim to reduce confusion for first-time users and contributors by keeping documentation accurate and more beginner-friendly. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

claunia added the pull-request label 2026-01-29 17:23:25 +00:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/ccextractor#2686