preparing 0.1.0

Author: aaronpowell

CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog for `react-static-web-apps-auth`
+
+## [0.1.0] - 2020-12-18
+
+Initial Release 🎉
+
+## Added
+
+- Components for login
+- Component for logout
+- Component for purging user profiles
+- Context for accessing user profile

README.md

@@ -1,6 +1,8 @@
 # Static Web App Auth tools for React
 
-This package is a series of helper tools for working with [Azure Static Web Apps](https://docs.microsoft.com/azure/static-web-apps/) [Authentication and Authorization](https://docs.microsoft.com/azure/static-web-apps/authentication-authorization) from React.
+![Node.js CI](https://github.com/aaronpowell/react-static-web-apps-auth/workflows/Node.js%20CI/badge.svg) | [![npm version](https://img.shields.io/npm/v/react-static-web-apps-auth)](https://npmjs.org/package/react-static-web-apps-auth)
+
+This package is a series of helper tools for working with [Azure Static Web Apps](https://docs.microsoft.com/azure/static-web-apps/?WT.mc_id=javascript-12079-aapowell) [Authentication and Authorization](https://docs.microsoft.com/azure/static-web-apps/authentication-authorization?WT.mc_id=javascript-12079-aapowell) from React.
 
 ## Installation
 
@@ -47,7 +49,7 @@ const App = () => {
 };
 ```
 
-This component provides React Context for the current user (or a series of `undefined` values when you're not logged in), aligning with the information available [in the Client Principal](https://docs.microsoft.com/azure/static-web-apps/user-information?tabs=javascript#client-principal-data).
+This component provides React Context for the current user (or a series of `undefined` values when you're not logged in), aligning with the information available [in the Client Principal](https://docs.microsoft.com/azure/static-web-apps/user-information?tabs=javascript#client-principal-data&WT.mc_id=javascript-12079-aapowell).
 
 Additionally, a `useContext` React Hook is available, `useUserInfo`, for use within the application.
 
@@ -59,7 +61,13 @@ To redirect to a specific URL post-logout, provide the path in the `postLogoutRe
 
 ### `<UserPurge />`
 
-This component provides the user with the ability to [remove their identifying information from Static Web Apps](https://docs.microsoft.com/azure/static-web-apps/authentication-authorization#remove-personal-identifying-information). By default it'll only purge them from the current domain, but set the `globally` prop to `true` if you with to give them the ability to completely remove themselves from Static Web Apps.
+This component provides the user with the ability to [remove their identifying information from Static Web Apps](https://docs.microsoft.com/azure/static-web-apps/authentication-authorization?WT.mc_id=javascript-12079-aapowell#remove-personal-identifying-information). By default it'll only purge them from the current domain, but set the `globally` prop to `true` if you with to give them the ability to completely remove themselves from Static Web Apps.
+
+## Styling
+
+Each of the components generates minimal HTML (a single `<a>` tag) to make it easier to style within an application. The DOM elements have the class `azure-swa-auth`, defined in `./constants` as `StaticWebAppsClassName`, on them, along with the component type, `login`, `logout` or `purge`.
+
+Additionally, the login components have the provider as a class, so providers can be styled individually.
 
 ## License
 

react-static-web-apps-auth/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aaronpowell/react-static-web-apps-auth",
   "version": "0.1.0",
-  "description": "",
+  "description": "A library to help creating authenticated React apps on Azure Static Web Apps",
   "main": "build/index.js",
   "types": "build/index.d.ts",
   "scripts": {
@@ -10,7 +10,16 @@
     "lint": "eslint src/**/*.ts",
     "lint:fix": "npm run lint -- --fix"
   },
-  "keywords": [],
+  "keywords": [
+    "react",
+    "azure",
+    "cloud",
+    "serverless",
+    "hosting",
+    "static",
+    "authentication",
+    "staticwebapp"
+  ],
   "author": {
     "name": "Aaron Powell",
     "email": "[email protected]",
@@ -38,5 +47,14 @@
   "peerDependencies": {
     "react": "^17.0.1",
     "react-dom": "^17.0.1"
-  }
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/aaronpowell/react-static-web-apps-auth"
+  },
+  "bugs": {
+    "url": "https://github.com/aaronpowell/react-static-web-apps-auth/issues"
+  },
+  "homepage": "https://github.com/aaronpowell/react-static-web-apps-auth",
+  "private": false
 }