Skip to content

Commit

Permalink
chore: update readme (#11)
Browse files Browse the repository at this point in the history
  • Loading branch information
johnhwhite authored Feb 11, 2023
2 parents 6cd4e23 + 84a0023 commit b1e21ae
Show file tree
Hide file tree
Showing 4 changed files with 25 additions and 6 deletions.
14 changes: 8 additions & 6 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
name: Release

on:
workflow_dispatch:
push:
branches:
- main
Expand All @@ -12,10 +13,11 @@ jobs:
name: Release Please
runs-on: ubuntu-latest
steps:
- uses: google-github-actions/release-please-action@v3.1.2
- uses: google-github-actions/release-please-action@v3
id: release
with:
release-type: node
default-branch: '${{ github.ref_name }}'
package-name: ng-keyboard-sort
path: libs/ng-keyboard-sort
token: ${{ secrets.GH_TOKEN }}
Expand All @@ -35,25 +37,25 @@ jobs:
]
- name: Checkout
uses: actions/checkout@v3
if: steps.release.outputs.release_created
if: ${{ steps.release.outputs.release_created }}
- name: Setup node
uses: actions/setup-node@v3
with:
node-version: ${{ env.node_version }}
registry-url: 'https://registry.npmjs.org'
if: steps.release.outputs.release_created
if: ${{ steps.release.outputs.release_created }}
- name: Cache node_modules
id: cache-node-modules
uses: actions/cache@v3
with:
path: node_modules
key: ${{ runner.os }}-node-${{ env.node_version }}-${{ hashFiles('**/package-lock.json') }}
if: steps.release.outputs.release_created
if: ${{ steps.release.outputs.release_created }}
- name: Install
run: npm ci
if: steps.release.outputs.release_created && steps.cache-node-modules.outputs.cache-hit != 'true'
if: ${{ steps.release.outputs.release_created && steps.cache-node-modules.outputs.cache-hit != 'true' }}
- name: Publish to NPM
if: steps.release.outputs.release_created
if: ${{ steps.release.outputs.release_created }}
env:
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
run: |
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# ng-keyboard-sort

[![CI](https://github.com/johnhwhite/ng-keyboard-sort/actions/workflows/ci.yml/badge.svg)](https://github.com/johnhwhite/ng-keyboard-sort/actions/workflows/ci.yml)
[![npm](https://img.shields.io/npm/v/ng-keyboard-sort/latest?label=ng-keyboard-sort)](https://www.npmjs.com/package/ng-keyboard-sort)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

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.

## Directives
Expand Down
2 changes: 2 additions & 0 deletions libs/ng-keyboard-sort/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# ng-keyboard-sort

[![CI](https://github.com/johnhwhite/ng-keyboard-sort/actions/workflows/ci.yml/badge.svg)](https://github.com/johnhwhite/ng-keyboard-sort/actions/workflows/ci.yml)
[![npm](https://img.shields.io/npm/v/ng-keyboard-sort/latest?label=ng-keyboard-sort)](https://www.npmjs.com/package/ng-keyboard-sort)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

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.
11 changes: 11 additions & 0 deletions libs/ng-keyboard-sort/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
{
"name": "ng-keyboard-sort",
"version": "1.0.1",
"repository": {
"type": "git",
"url": "https://github.com/johnhwhite/ng-keyboard-sort.git",
"directory": "projects/ng-keyboard-sort",
"branch": "main"
},
"peerDependencies": {
"@angular/cdk": "^15.0.0",
"@angular/common": "^15.0.0",
Expand All @@ -9,5 +15,10 @@
"dependencies": {
"tslib": "^2.3.0"
},
"keywords": [
"angular",
"keyboard",
"sort"
],
"sideEffects": false
}

0 comments on commit b1e21ae

Please sign in to comment.