diff --git a/README.md b/README.md index 8f1af30..91c999f 100644 --- a/README.md +++ b/README.md @@ -1 +1,26 @@ -# security-txt +# Security-TXT Plugin + +This plugin creates a security.txt file in the WordPress installation root. You can edit/add to this file within the WordPress SecurityTXT settings page. The purpose of the security.txt file is to allow users to properly disclose security vulnerabilities or bugs to you. This is best practice and a standard. + +## Installation + +Build for npm is coming soon. This will happen with a new release to make the admin page look better. + +Install packages +```bash +npm install +``` + +Compile SCSS +```bash +npm run build +``` + +## Contributing + +Pull requests are welcome. For major changes, please open an issue first +to discuss what you would like to change. + +## License + +GPLv3 or later diff --git a/admin/scss/styles.scss b/admin/scss/styles.scss index e69de29..d7466c2 100644 --- a/admin/scss/styles.scss +++ b/admin/scss/styles.scss @@ -0,0 +1 @@ +/**Future styles here **/ diff --git a/package.json b/package.json index 91cae57..d77344d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "security-txt", - "version": "0.0.1", + "version": "1.0.0", "author": "Tyler Stokes ", "license": "GPLv3 or later", "main": "security-txt.php", diff --git a/security-txt.php b/security-txt.php index f70e6f8..2651201 100644 --- a/security-txt.php +++ b/security-txt.php @@ -4,9 +4,10 @@ * Description: Creates a security.txt file with contact info. * Plugin Name: Security TXT * Plugin URI: - * Version: 0.0.1 - * @author Tyler Stokes - * @license GPLv3 or later + * Version: 1.0.0 + * Author: Tyler Stokes + * Author URI: https://tswebservices.com/ + * License: GPLv3 or later * Text Domain: securitytxt * PHP Version: 7.0 */ @@ -87,7 +88,7 @@ function st_maybe_delete_options() { add_action( 'admin_menu', 'st_menu_item' ); if ( ! function_exists('st_menu_item') ) { function st_menu_item() { - add_submenu_page( 'tools.php', 'Security TXT', 'Security-TXT Options', 'manage_options', 'security-txt', 'securitytxt_form_func' ); + add_submenu_page( 'tools.php', 'Security TXT', 'Security TXT', 'manage_options', 'security-txt', 'securitytxt_form_func' ); add_action( 'admin_init', 'register_securitytxt_settings' ); } }