Skip to content

Commit ebbce66

Browse files
CodyToleneCodyTolene
authored
v20.3.6 - Quick readme and package updates.
* Quick update to README and packages (security updates). * Add pull request template * Quick readme updates suggestions added.
1 parent e2682d2 commit ebbce66

File tree

4 files changed

+54
-39
lines changed

4 files changed

+54
-39
lines changed

‎.github/pull_request_template.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
### Description
2+
3+
A brief overview of your completed or ongoing work.
4+
5+
### Developement Checklist
6+
7+
- [ ] Bump version up (`package.json` **and** `package-lock.json`)
8+
9+
### Preview(s)
10+
11+
- Add screenshots, gifs, videos, etc. here for a quick preview if applicable.

‎README.md‎

Lines changed: 32 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,17 @@
1-
<p align="center">
1+
<div align="center">
22
<a href="https://www.ProAngular.com" target="_blank">
33
<img src="https://raw.githubusercontent.com/ProAngular/ngx-gist/refs/heads/main/public/images/pro-angular-logo.png" />
44
</a>
55
<h1 align="center">
6-
<a href="https://www.ProAngular.com" target="_blank">
7-
Pro Angular
8-
</a>: GitHub Gist Code Snippet Viewer
6+
<a href="https://www.ProAngular.com" target="_blank">Pro Angular</a>: ngx-gist
97
</h1>
10-
</p>
8+
<a align="center" href="https://github.com/ProAngular/ngx-gist" target="_blank">
9+
View GitHub Repository
10+
</a>
11+
<p align="center">
12+
An Angular Material and HighlighJs styled display box for GitHub gist and local code snippets.
13+
</p>
14+
</div>
1115

1216
<!---------------------------------------------------------------------------->
1317
<!---------------------------------------------------------------------------->
@@ -74,12 +78,12 @@ More info in the following links:
7478

7579
## Description <a name="description"></a>
7680

77-
Behold, this package contains an Angular Material and HighlighJs styled element
78-
which displays your GitHub gists in a conveniant, easy to view interface. Don't
79-
have a gist? No problem, display your own code snippets by just passing in a
80-
direct model (`NgxGist.create({ ... })`)! All files from the remote/local gist
81-
are displayed in separate tabs for users to easily navigate. Many optional
82-
features and themes are available.
81+
Behold, this package contains an Angular Material and Highlight.js styled
82+
element which displays your GitHub gists in a conveniant, easy to view
83+
interface. Don't have a gist? No problem, display your own code snippets by just
84+
passing in a direct model (`NgxGist.create({ ... })`)! All files from the
85+
remote/local gist are displayed in separate tabs for users to easily navigate.
86+
Many optional features and themes are available.
8387

8488
GitHub gists can be created here: https://gist.github.com/
8589

@@ -297,17 +301,17 @@ Line numbers are enabled by default, but you can turn them off like so.
297301

298302
## Compatibility <a name="compatibility"></a>
299303

300-
| Angular version | @proangular/ngx-gist | Install |
301-
| --------------- | -------------------- | ------------------------------------- |
302-
| v20 | v20.x.0 | `ng add @proangular/ngx-gist@^20.0.0` |
303-
| v19 | v19.x.0 | `ng add @proangular/ngx-gist@^19.0.0` |
304-
| v18 | ------ | Untested |
305-
| v17 | v1.3.x | `ng add @proangular/ngx-gist@~1.3.0` |
306-
| v16 | v1.2.x | `ng add @proangular/ngx-gist@~1.2.0` |
307-
| v15 | v1.1.x | `ng add @proangular/ngx-gist@~1.1.0` |
308-
| v14 | v1.0.x | `ng add @proangular/ngx-gist@~1.0.8` |
309-
| v13 | v1.0.x | `ng add @proangular/ngx-gist@~1.0.8` |
310-
| v12 | v1.0.x | `ng add @proangular/ngx-gist@~1.0.8` |
304+
| Angular version | @proangular/ngx-gist | Install |
305+
| --------------- | -------------------- | ------------------------------------ |
306+
| v20 | v20.x | `ng add @proangular/ngx-gist@^20` |
307+
| v19 | v19.x | `ng add @proangular/ngx-gist@^19` |
308+
| v18 | ------ | Untested |
309+
| v17 | v1.3.x | `ng add @proangular/ngx-gist@~1.3.0` |
310+
| v16 | v1.2.x | `ng add @proangular/ngx-gist@~1.2.0` |
311+
| v15 | v1.1.x | `ng add @proangular/ngx-gist@~1.1.0` |
312+
| v14 | v1.0.x | `ng add @proangular/ngx-gist@~1.0.8` |
313+
| v13 | v1.0.x | `ng add @proangular/ngx-gist@~1.0.8` |
314+
| v12 | v1.0.x | `ng add @proangular/ngx-gist@~1.0.8` |
311315

312316
<p align="right">[ <a href="#index">Index</a> ]</p>
313317

@@ -369,12 +373,12 @@ Thank you to the entire Angular team and community for such a great framework to
369373
build upon. If you have any questions, please let me know by opening an issue
370374
[here][url-new-issue].
371375

372-
| Type | Info |
373-
| :------------------------------------------------------------------------ | :------------------------------------------------------------- |
374-
| <img width="48" src=".github/images/ng-icons/email.svg" /> | webmaster@codytolene.com |
375-
| <img width="48" src=".github/images/simple-icons/github.svg" /> | https://github.com/sponsors/CodyTolene |
376-
| <img width="48" src=".github/images/simple-icons/buymeacoffee.svg" /> | https://www.buymeacoffee.com/codytolene |
377-
| <img width="48" src=".github/images/simple-icons/bitcoin-btc-logo.svg" /> | bc1qfx3lvspkj0q077u3gnrnxqkqwyvcku2nml86wmudy7yf2u8edmqq0a5vnt |
376+
| Type | Info |
377+
| :---------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------- |
378+
| <img width="48" src="https://raw.githubusercontent.com/ProAngular/ngx-gist/refs/heads/main/.github/images/ng-icons/email.svg" /> | webmaster@codytolene.com |
379+
| <img width="48" src="https://raw.githubusercontent.com/ProAngular/ngx-gist/refs/heads/main/.github/images/simple-icons/github.svg" /> | https://github.com/sponsors/CodyTolene |
380+
| <img width="48" src="https://raw.githubusercontent.com/ProAngular/ngx-gist/refs/heads/main/.github/images/simple-icons/buymeacoffee.svg" /> | https://www.buymeacoffee.com/codytolene |
381+
| <img width="48" src="https://raw.githubusercontent.com/ProAngular/ngx-gist/refs/heads/main/.github/images/simple-icons/bitcoin-btc-logo.svg" /> | bc1qfx3lvspkj0q077u3gnrnxqkqwyvcku2nml86wmudy7yf2u8edmqq0a5vnt |
378382

379383
Fin. Happy programming friend!
380384

‎package-lock.json‎

Lines changed: 10 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@proangular/ngx-gist",
3-
"version": "20.3.5",
3+
"version": "20.3.6",
44
"description": "An Angular Material and HighlighJs styled display box for GitHub gist and local code snippets.",
55
"author": "Pro Angular <webmaster@proangular.com>",
66
"homepage": "https://www.proangular.com",

0 commit comments

Comments
 (0)