@apolitical/eslint-config 1.0.0-beta.0 → 1.0.0

package/CHANGELOG.md

@@ -5,11 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-
 ## [1.0.0] - 2022-01-17
 ### Changed
-- Dependencies
-- Node.js version
+- Updated Dependencies
+- Upgraded Node.js version
+- Revamped GitLab pipelines
 
 ## [0.0.1] - 2021-06-29
 ### Added

package/README.md

@@ -1,3 +1,32 @@
 # Apolitical Eslint Config
 
-A node module for our code style
+Apolitical ESLint configuration for Node.js projects (backend)
+
+## Requirements
+
+Requires the following to run:
+
+- [node.js][node] 16.13.2+
+- [yarn][yarn]
+
+[node]: https://nodejs.org/en/download/
+[yarn]: https://classic.yarnpkg.com/en/docs/install
+
+## Installation
+
+Install with `yarn`:
+
+```sh
+yarn add -D @apolitical/eslint-config
+```
+
+## Usage
+
+Link the ESLint configurations from your `package.json`:
+
+```json
+  "eslintConfig": {
+    "extends": "@apolitical/eslint-config/base.config"
+  },
+  "prettier": "@apolitical/eslint-config/prettier.config",
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@apolitical/eslint-config",
-  "version": "1.0.0-beta.0",
+  "version": "1.0.0",
   "description": "Apolitical ESLint configuration for Node.js projects (backend)",
   "author": "Apolitical Group Limited <engineering@apolitical.co>",
   "license": "MIT",