diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..71bced8 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,11 @@ +### Description + +A brief overview of your completed or ongoing work. + +### Developement Checklist + +- [ ] Bump version up (`package.json` **and** `package-lock.json`) + +### Preview(s) + +- Add screenshots, gifs, videos, etc. here for a quick preview if applicable. diff --git a/README.md b/README.md index ee7c63b..b0f78c5 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,17 @@ -

+

- - Pro Angular - : GitHub Gist Code Snippet Viewer + Pro Angular: ngx-gist

-

+ + View GitHub Repository + +

+ An Angular Material and HighlighJs styled display box for GitHub gist and local code snippets. +

+
@@ -74,12 +78,12 @@ More info in the following links: ## Description -Behold, this package contains an Angular Material and HighlighJs styled element -which displays your GitHub gists in a conveniant, easy to view interface. Don't -have a gist? No problem, display your own code snippets by just passing in a -direct model (`NgxGist.create({ ... })`)! All files from the remote/local gist -are displayed in separate tabs for users to easily navigate. Many optional -features and themes are available. +Behold, this package contains an Angular Material and Highlight.js styled +element which displays your GitHub gists in a conveniant, easy to view +interface. Don't have a gist? No problem, display your own code snippets by just +passing in a direct model (`NgxGist.create({ ... })`)! All files from the +remote/local gist are displayed in separate tabs for users to easily navigate. +Many optional features and themes are available. GitHub gists can be created here: https://gist.github.com/ @@ -297,17 +301,17 @@ Line numbers are enabled by default, but you can turn them off like so. ## Compatibility -| Angular version | @proangular/ngx-gist | Install | -| --------------- | -------------------- | ------------------------------------- | -| v20 | v20.x.0 | `ng add @proangular/ngx-gist@^20.0.0` | -| v19 | v19.x.0 | `ng add @proangular/ngx-gist@^19.0.0` | -| v18 | ------ | Untested | -| v17 | v1.3.x | `ng add @proangular/ngx-gist@~1.3.0` | -| v16 | v1.2.x | `ng add @proangular/ngx-gist@~1.2.0` | -| v15 | v1.1.x | `ng add @proangular/ngx-gist@~1.1.0` | -| v14 | v1.0.x | `ng add @proangular/ngx-gist@~1.0.8` | -| v13 | v1.0.x | `ng add @proangular/ngx-gist@~1.0.8` | -| v12 | v1.0.x | `ng add @proangular/ngx-gist@~1.0.8` | +| Angular version | @proangular/ngx-gist | Install | +| --------------- | -------------------- | ------------------------------------ | +| v20 | v20.x | `ng add @proangular/ngx-gist@^20` | +| v19 | v19.x | `ng add @proangular/ngx-gist@^19` | +| v18 | ------ | Untested | +| v17 | v1.3.x | `ng add @proangular/ngx-gist@~1.3.0` | +| v16 | v1.2.x | `ng add @proangular/ngx-gist@~1.2.0` | +| v15 | v1.1.x | `ng add @proangular/ngx-gist@~1.1.0` | +| v14 | v1.0.x | `ng add @proangular/ngx-gist@~1.0.8` | +| v13 | v1.0.x | `ng add @proangular/ngx-gist@~1.0.8` | +| v12 | v1.0.x | `ng add @proangular/ngx-gist@~1.0.8` |

[ Index ]

@@ -369,12 +373,12 @@ Thank you to the entire Angular team and community for such a great framework to build upon. If you have any questions, please let me know by opening an issue [here][url-new-issue]. -| Type | Info | -| :------------------------------------------------------------------------ | :------------------------------------------------------------- | -| | webmaster@codytolene.com | -| | https://github.com/sponsors/CodyTolene | -| | https://www.buymeacoffee.com/codytolene | -| | bc1qfx3lvspkj0q077u3gnrnxqkqwyvcku2nml86wmudy7yf2u8edmqq0a5vnt | +| Type | Info | +| :---------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------- | +| | webmaster@codytolene.com | +| | https://github.com/sponsors/CodyTolene | +| | https://www.buymeacoffee.com/codytolene | +| | bc1qfx3lvspkj0q077u3gnrnxqkqwyvcku2nml86wmudy7yf2u8edmqq0a5vnt | Fin. Happy programming friend! diff --git a/package-lock.json b/package-lock.json index e9b5014..c167bc3 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@proangular/ngx-gist", - "version": "20.3.5", + "version": "20.3.6", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@proangular/ngx-gist", - "version": "20.3.5", + "version": "20.3.6", "hasInstallScript": true, "license": "MIT", "devDependencies": { @@ -5417,11 +5417,11 @@ "license": "ISC" }, "node_modules/cacache/node_modules/tar": { - "version": "7.5.1", - "resolved": "https://registry.npmjs.org/tar/-/tar-7.5.1.tgz", - "integrity": "sha512-nlGpxf+hv0v7GkWBK2V9spgactGOp0qvfWRxUMjqHyzrt3SgwE48DIv/FhqPHJYLHpgW1opq3nERbz5Anq7n1g==", + "version": "7.5.2", + "resolved": "https://registry.npmjs.org/tar/-/tar-7.5.2.tgz", + "integrity": "sha512-7NyxrTE4Anh8km8iEy7o0QYPs+0JKBTj5ZaqHg6B39erLg0qYXN3BijtShwbsNSvQ+LN75+KV+C4QR/f6Gwnpg==", "dev": true, - "license": "ISC", + "license": "BlueOak-1.0.0", "dependencies": { "@isaacs/fs-minipass": "^4.0.0", "chownr": "^3.0.0", @@ -10554,11 +10554,11 @@ } }, "node_modules/node-gyp/node_modules/tar": { - "version": "7.5.1", - "resolved": "https://registry.npmjs.org/tar/-/tar-7.5.1.tgz", - "integrity": "sha512-nlGpxf+hv0v7GkWBK2V9spgactGOp0qvfWRxUMjqHyzrt3SgwE48DIv/FhqPHJYLHpgW1opq3nERbz5Anq7n1g==", + "version": "7.5.2", + "resolved": "https://registry.npmjs.org/tar/-/tar-7.5.2.tgz", + "integrity": "sha512-7NyxrTE4Anh8km8iEy7o0QYPs+0JKBTj5ZaqHg6B39erLg0qYXN3BijtShwbsNSvQ+LN75+KV+C4QR/f6Gwnpg==", "dev": true, - "license": "ISC", + "license": "BlueOak-1.0.0", "dependencies": { "@isaacs/fs-minipass": "^4.0.0", "chownr": "^3.0.0", diff --git a/package.json b/package.json index 84ac233..9351c70 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@proangular/ngx-gist", - "version": "20.3.5", + "version": "20.3.6", "description": "An Angular Material and HighlighJs styled display box for GitHub gist and local code snippets.", "author": "Pro Angular ", "homepage": "https://www.proangular.com",