Skip to content

refactor/updated Readme#21

Merged
leo-gan merged 1 commit intoleo-gan:mainfrom
LeoGan:refactor/readme
Sep 29, 2025
Merged

refactor/updated Readme#21
leo-gan merged 1 commit intoleo-gan:mainfrom
LeoGan:refactor/readme

Conversation

@leo-gan
Copy link
Owner

@leo-gan leo-gan commented Sep 29, 2025

No description provided.

@gemini-code-assist
Copy link

Summary of Changes

Hello @leo-gan, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request primarily focuses on improving the documentation by updating the README.md file. The changes aim to provide a more comprehensive and structured overview of the PDF Anonymizer's core functionalities and benefits, making it easier for users to understand its capabilities at a glance. A small wording change was also included to enhance clarity in the design considerations.

Highlights

  • Enhanced README Features List: The main description of the PDF Anonymizer application in the README.md has been expanded from a single sentence to a detailed bulleted list. This new list clearly outlines key features such as high-quality anonymization, consistent handling of large files (up to 1GB), cost-free operation with open-source LLMs (via Ollama), deanonymization capabilities, and support for PDF, Markdown, and plain text files.
  • Wording Refinement: A minor textual adjustment was made in the 'Design Considerations' section of the README.md, changing 'LLM recognizes and anonymizes' to 'LLM can anonymize' for improved clarity and precision.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@leo-gan leo-gan merged commit e8f6e57 into leo-gan:main Sep 29, 2025
2 checks passed
@leo-gan leo-gan deleted the refactor/readme branch September 29, 2025 21:20
Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request refactors the README file to present the application's features more clearly using a bulleted list. The changes improve the initial overview of the project. My review includes a couple of suggestions to fix typos and improve the wording for better professionalism and clarity in the documentation.

This application anonymizes large PDF, Markdown or Text files using LLMs.
It generates an anonymized version of the text and a mapping vocabulary of the original entities to their anonymized replacements.
- LLM anonymizes text with `high quality`.
- It anonymizes `large files consistently`. I've tried 1GB files.

Choose a reason for hiding this comment

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

medium

The phrase "I've tried 1GB files" is a bit informal for project documentation. It would be more professional to state the capability of the tool directly, for example, by mentioning that it has been tested with files of that size.

Suggested change
- It anonymizes `large files consistently`. I've tried 1GB files.
- It anonymizes `large files consistently`. Tested with files up to 1GB.

It generates an anonymized version of the text and a mapping vocabulary of the original entities to their anonymized replacements.
- LLM anonymizes text with `high quality`.
- It anonymizes `large files consistently`. I've tried 1GB files.
- Anonymizes for `free`, if you use an open-source LLM (It uses hashtag#Ollama underhood for OS LLMs)

Choose a reason for hiding this comment

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

medium

There appear to be a couple of typos on this line. "hashtag#Ollama" should likely be just "Ollama", and "underhood" should be "under the hood". It would also be beneficial to make "Ollama" a link for users who might not be familiar with it, and correct the capitalization of "It" inside the parentheses.

Suggested change
- Anonymizes for `free`, if you use an open-source LLM (It uses hashtag#Ollama underhood for OS LLMs)
- Anonymizes for `free`, if you use an open-source LLM (it uses [Ollama](https://ollama.com/) under the hood for OS LLMs)

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.

1 participant