Commit graph

33 commits

Author SHA1 Message Date
b76e5ef57d
Fix typo errors and correct 'pronouncable' to 'pronounceable' in README
Corrected all the occurrences of the word 'pronouncable' to correct spelling 'pronounceable' across the README file. Also fixed a small typo 'apt-go', replaced it with the correct term 'apg-go'. The changes ensure correct spelling and consistent terminology in the README document.
2024-03-16 10:37:17 +01:00
4ee866bd61
Update README with detailed installation instructions
The README file has been updated with thorough installation instructions. Changes range from introducing binary and package releases, including their verification using GPG signature, to refactoring the source code installation steps. Additionally, instructions for specific platforms like FreeBSD, Arch Linux, Debian/Redhat/Alpine, etc., have been improved for clarity.
2024-03-16 10:27:56 +01:00
ddae28d1a9
Correct version references in README and apg.go
The version number in several instances in the README file and apg.go has been modified from v2.0.0 to v1.0.0. This more accurately reflects the version where the changes were implemented and ensures consistency across all documentation.
2024-03-14 11:26:32 +01:00
3847ab0735
Update GPG key contact info in README.md
Updated the "Winni Neessen" Software signing key contact details in the README file for better readability and neatness. This conveys the same information but in a more compressed, comprehensible manner.
2024-03-14 11:08:48 +01:00
6b08e1077c
Update README with new features and clean-up goreleaser config
Updated the README file to document new features added in the codebase: codecov badge, pre-built package usage, fixed-length password flag usage, coinflip mode, and the minimum required characters. The goreleaser configuration (`.goreleaser.yaml`) was cleaned up, removing unnecessary sections for docker usage. This clarifies how to execute certain functionalities and makes the goreleaser configuration easier to read and maintain.
2024-03-14 11:07:56 +01:00
cf47feecbb
Update project URLs and refactor Dockerfile
Project URLs have been changed in several files from "src.neessen.cloud/wneessen/apg-go" to "github.com/wneessen/apg-go". In addition, Dockerfile has been significantly refactored. It now includes steps for tidy and verify of Go modules and builds a statically linked binary. Several metadata files have been added with copyright information.
2024-03-14 09:37:52 +01:00
d4d2067cbf
Add Discord and REUSE badges to README
This commit introduces two new badges to the README file. The first badge directs users to the project's Discord server, promoting community contributions. The second badge verifies that the project complies with REUSE software recommendations, ensuring users of the project's commitment to best practices in software development.
2024-03-12 22:52:25 +01:00
8fef635664
Update badges links in README.md
This commit updates the existing badge references on the README.md file. The previous badge links were pointing to GitHub locations, these are being changed to point to 'src.neessen.cloud', potentially reflecting a move away from GitHub.
2024-03-12 21:02:25 +01:00
79f921f9ad
Add .gitgnore and SPDX headers in several files
This commit introduces the .gitignore configuration file and adds SPDX headers to several files including test and documentation files. The headers provide license information in a standardized format which can be easily picked up by automated tools for license compliance checks. Additionally, it deleted a .idea/.gitignore file, which is a project specific IDE configuration file not necessary for the repository. It also introduced a README.md file providing more insightful information about the project.
2024-03-12 20:59:07 +01:00
befa6c2723
Remove old code for the v2 refactor 2023-04-06 12:21:20 +02:00
55f9634902
Add Dockerfile so apg-go can be dockerized via Github 2022-05-11 14:51:58 +02:00
1f682e8f34
Update README.md 2022-05-06 20:46:23 +02:00
8e83a66b12
Update README.md
Added aberoham to contributors list
2022-04-02 23:08:23 +02:00
da4a9b1040 Updated README.md and added code-example for programmatic use 2021-09-23 19:20:17 +02:00
1b393d8692 More README.md updates 2021-09-23 16:32:03 +02:00
cdf0237034 README.md updated 2021-09-23 16:27:08 +02:00
aeb278355c Minor code cleanups and updated README to reflect #27 2021-09-23 15:48:03 +02:00
6d17f5fd72
Update README.md 2021-09-23 14:49:21 +02:00
097b4f1551
Update README.md 2021-09-22 17:41:48 +02:00
39b023d56d
Updated README.md
README not only reflects the changes of v0.3.2 now, but also has
received a bunch of usage examples, as requested in #25.
2021-04-29 14:04:27 +02:00
42d3868ea3
Wrong AUR link 2021-04-17 11:56:51 +02:00
ef67464d57
Replaced "apg.go" with "apg-go" 2021-04-17 11:55:32 +02:00
232497cd2e
Added "Ports/Packages" section to README.md 2021-04-17 11:54:17 +02:00
9277e83fd4
v0.3.1: New password length behaviour
To address issue #13, the password length behaviour of the
original APG has been reproduced. Previously, when a minLength
of 5 and a maxLength of 10 was given, apg-go se the pwLength to
the preferred maxLength.

With v0.3.1 it will choose a random length between minLength and
maxLength instead, same as the original C-lang apg did. For this
the minLength has been defaulted to a sane value of 12 (instead
of the 8 of the original apg). The default for maxLength stayed
at 20.

Also the default number of generated passwords has been changed
from 1 to 6, to replicate the behaviour of the original apg.
2021-04-17 11:04:14 +02:00
f13ffdf406
Updated PKGBUILD for 0.3.0 2021-04-01 11:01:47 +02:00
8a7c00a522
v0.3.0: Unified the naming convention 2021-04-01 10:53:51 +02:00
f20b0e2517
Update README.md 2021-03-30 19:49:05 +02:00
108e518701
Update README.md 2021-03-30 19:48:26 +02:00
d975c5d1db
Updates README.md. We are ready for v0.2.5 2021-03-21 18:29:27 +01:00
dfa8eda0bd
Updated README and gitignore files 2021-03-19 08:31:02 +01:00
d884110209
Updated README.md 2021-03-19 00:56:13 +01:00
5d743f70ae
v0.1.0: Initial check-in 2021-03-18 23:26:41 +01:00
ebdad33364
Initial commit 2021-03-18 23:13:10 +01:00