chore: changelog and new readme
This commit is contained in:
parent
711880a670
commit
1a1431c85e
@ -1,5 +1,13 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## v1.0.1 (2025-07-25)
|
||||||
|
|
||||||
|
<!-- auto-changelog -->
|
||||||
|
|
||||||
|
### Known Issues
|
||||||
|
|
||||||
|
- help flags can cause issues
|
||||||
|
|
||||||
## v1.0.0 (2025-07-25)
|
## v1.0.0 (2025-07-25)
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
|
63
README.md
63
README.md
@ -1,7 +1,16 @@
|
|||||||
# Emma's Simple Form Field Checker
|
# BearMetal PDF Tools
|
||||||
|
|
||||||
Compares a PDF form to a list of CS class files to see if all field names are
|
A collection of tools for working with PDF forms.
|
||||||
present, excluding signature fields.
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Check Code Tool
|
||||||
|
- reads supplied code files to see if form fields are present and represented
|
||||||
|
in a switch statement
|
||||||
|
- Field Rename Tool
|
||||||
|
- provide a search and replace pattern to bulk rename form fields
|
||||||
|
- List Form Fields
|
||||||
|
- Sometimes you just need to see what fields there are
|
||||||
|
|
||||||
## Prereqs
|
## Prereqs
|
||||||
|
|
||||||
@ -20,17 +29,51 @@ Deno >=2.2 (not required if downloading .exe)
|
|||||||
> If you want it to be a global command, create an executables directory and add
|
> If you want it to be a global command, create an executables directory and add
|
||||||
> it to the PATH
|
> it to the PATH
|
||||||
|
|
||||||
|
### Precompiled
|
||||||
|
|
||||||
|
Download the latest release from the
|
||||||
|
[releases page](https://git.cyborggrizzly.com/BearMetal/pdf-tools/releases)
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
`checkfields <path to PDF> <comma-separated list of paths to CS class files>`
|
`pdf-tools <tool> <args>` -> `<tool>` is one of the following
|
||||||
-OR- `checkfields` and follow prompts.
|
|
||||||
|
|
||||||
### Output
|
- check-code
|
||||||
|
- field-rename
|
||||||
|
- list-form-fields
|
||||||
|
|
||||||
> All form fields present!
|
## Contributing
|
||||||
|
|
||||||
-OR-
|
Contributions are welcome!
|
||||||
|
|
||||||
> The following field names are not present in the CS code
|
## License
|
||||||
|
|
||||||
> \<list of missing form fields\>
|
GPL 3.0
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### About this project
|
||||||
|
|
||||||
|
BearMetal PDF Tools is a collection of tools made to fix the current state of
|
||||||
|
PDF form editing. Adobe Acrobat is a great tool, but it's not always the easiest
|
||||||
|
to use, nor is it free. It also lacks some features that I find useful, such as
|
||||||
|
bulk renaming of form fields. There's also a lack of powerful, free, and open
|
||||||
|
source tools for PDF editing.
|
||||||
|
|
||||||
|
This project aims to fill that gap by providing a set of tools that can be used
|
||||||
|
to edit PDF forms. The tools are written in Deno, a modern and secure runtime
|
||||||
|
for JavaScript and TypeScript. They are designed to be easy to use and to
|
||||||
|
provide a great user experience.
|
||||||
|
|
||||||
|
The tools are designed to be used in a terminal, and are not designed to be
|
||||||
|
integrated into other applications. They are also not designed to be used as a
|
||||||
|
library, but rather as a command line tool.
|
||||||
|
|
||||||
|
### About BearMetal
|
||||||
|
|
||||||
|
BearMetal is a project that aims to decrapify modern web development. It is a
|
||||||
|
collection of tools, libraries, and resources that aim to make web development
|
||||||
|
more accessible and less intimidating. The project is open source and free to
|
||||||
|
use, and is designed to be used by anyone, regardless of skill level or
|
||||||
|
experience. You can find a list of libraries and tools on
|
||||||
|
[JSR](https://jsr.io/@bearmetal).
|
||||||
|
Loading…
x
Reference in New Issue
Block a user