Skip to content

Commit

Permalink
docs: update readme (#54)
Browse files Browse the repository at this point in the history
  • Loading branch information
johnhwhite authored Apr 9, 2023
1 parent fdeb11e commit 60d51a4
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
4 changes: 0 additions & 4 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,10 +36,8 @@ jobs:
cd dist/ng-keyboard-sort
npm config set '//registry.npmjs.org/:_authToken=${{secrets.NPM_TOKEN}}'
set -x
npm whoami --registry https://registry.npmjs.org
npm pkg set "version=${VERSION}"
npm publish --access public --tag "v${MAJOR_VERSION}-lts"
npm logout
npm config delete '//registry.npmjs.org/:_authToken'
- name: Publish to GitHub Packages
run: |
Expand All @@ -48,11 +46,9 @@ jobs:
npm config set '@${{ github.repository_owner }}:registry=https://npm.pkg.github.com'
npm config set '//npm.pkg.github.com/:_authToken=${{secrets.GH_TOKEN}}'
set -x
npm whoami --registry https://npm.pkg.github.com
npm pkg set "version=${VERSION}"
npm pkg set "name=@${{ github.repository_owner }}/ng-keyboard-sort"
npm pkg set "publishConfig.registry=https://npm.pkg.github.com"
npm publish
npm logout
npm config delete '@${{ github.repository_owner }}:registry'
npm config delete '//npm.pkg.github.com/:_authToken'
14 changes: 14 additions & 0 deletions libs/ng-keyboard-sort/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,17 @@
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)](https://stackblitz.com/fork/github/johnhwhite/ng-keyboard-sort?file=apps%2Fe2e%2Fsrc%2Fapp%2Fexample%2Fexample.component.html)

Library to add keyboard commands for elements that also use CDK drag and drop sorting. This library intends to provide parity for picking up an element with the keyboard, moving it up and down the list, and dropping it in place.

## Install

```bash
npm install ng-keyboard-sort
```

## Demo

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)](https://stackblitz.com/fork/github/johnhwhite/ng-keyboard-sort?file=apps%2Fe2e%2Fsrc%2Fapp%2Fexample%2Fexample.component.html)

## GitHub

[johnhwhite/ng-keyboard-sort](https://github.com/johnhwhite/ng-keyboard-sort)

0 comments on commit 60d51a4

Please sign in to comment.