Properly initialize this repo (#13)

Follow the instructions that we have in the module template (see
"Template Instructions" in the README, which are being deleted in this
commit) for new repos in order to customize the README, `package.json`,
and pull request template for this repo.

Progresses #5.

.github/pull_request_template.md

@@ -9,11 +9,3 @@ Are there any issues or other links reviewers should consult to understand this
 * Fixes #12345
 * See: #67890
 -->
-
-## Examples
-
-<!--
-Are there any examples of this change being used in another repository?
-
-When considering changes to the MetaMask module template, it's strongly preferred that the change be experimented with in another repository first. This gives reviewers a better sense of how the change works, making it less likely the change will need to be reverted or adjusted later.
--->

CHANGELOG.md

@@ -6,4 +6,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-[Unreleased]: https://github.com/MetaMask/metamask-module-template/
+[Unreleased]: https://github.com/MetaMask/module-lint/

README.md

@@ -1,47 +1,24 @@
-# MetaMask Module Template
-
-This TypeScript module is maintained in the style of the MetaMask team.
-
-## Template Instructions
-
-Follow these instructions when using this template.
-
-- Update the package name, referenced in the following places:
-  - The `name` field of `package.json`
-  - The README title
-  - The README "Usage" section
-- Update the package description
-  - The package description is referenced at the beginning of the README, and in the `description` field of `package.json`.
-- Update the repository URL, referenced in the following places:
-  - `repository` field of `package.json`
-  - The links in the API section of the README
-- If your project has side effects, update the `sideEffects` field of
-  `package.json` to `true`, or an array of file globs that match the files that
-  have side effects.
-- Update the pull request template (`.github/pull_request_template.md`) to remove the `Examples` section that is specific to this template.
-- Update the README "Usage" section, or remove it if it's not needed.
-- Update the CODEOWNERS file to set the appropriate code owners for the repository (typically one or more engineering teams)
-  - Ensure each referenced team has write permission, and that the engineering team still has write permission.
-- Delete these instructions.
+# @metamask/module-lint
 
-## Installation
+This repo provides a tool which can be used to analyze one or more repos, running defined checks that measure divergence from a template repo, and outputs a report of the results.
 
-`yarn add @metamask/this-module`
+At the moment, this tool only processes MetaMask repositories using the [MetaMask module template](https://github.com/MetaMask/metamask-module-template) as a basis, and all of the checks are predefined and cannot be customized.
 
-or
+## Installation
 
-`npm install @metamask/this-module`
+This tool is designed to be used globally and does not need to be installed within an individual project.
 
 ## Usage
 
-_Add examples here_
-
-## API
+To use the tool, run:
 
-See our documentation:
+```
+# Yarn
+yarn dlx @metamask/module-lint
 
-- [Latest published API documentation](https://metamask.github.io/metamask-module-template/latest/)
-- [Latest development API documentation](https://metamask.github.io/metamask-module-template/staging/)
+# NPM
+npx @metamask/module-lint
+```
 
 ## Contributing
 

package.json

@@ -1,14 +1,14 @@
 {
-  "name": "@metamask/module-template",
+  "name": "@metamask/module-lint",
   "version": "0.0.0",
-  "description": "The MetaMask Node module template",
-  "homepage": "https://github.com/MetaMask/metamask-module-template#readme",
+  "description": "Analyzes one or more repos for divergence from a template repo",
+  "homepage": "https://github.com/MetaMask/module-lint#readme",
   "bugs": {
-    "url": "https://github.com/MetaMask/metamask-module-template/issues"
+    "url": "https://github.com/MetaMask/module-lint/issues"
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/MetaMask/metamask-module-template.git"
+    "url": "https://github.com/MetaMask/module-lint.git"
   },
   "sideEffects": false,
   "exports": {

yarn.lock

@@ -942,9 +942,9 @@ __metadata:
   languageName: node
   linkType: hard
 
-"@metamask/module-template@workspace:.":
+"@metamask/module-lint@workspace:.":
   version: 0.0.0-use.local
-  resolution: "@metamask/module-template@workspace:."
+  resolution: "@metamask/module-lint@workspace:."
   dependencies:
     "@lavamoat/allow-scripts": ^2.3.1
     "@lavamoat/preinstall-always-fail": ^1.0.0