Skip to content

Commit

Permalink
Reflect repo name change (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
russelporosky authored Oct 12, 2023
1 parent 5b00bf4 commit 0960834
Show file tree
Hide file tree
Showing 9 changed files with 33 additions and 33 deletions.
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* @metaloha
* @russelporosky
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ This Code of Conduct applies within all project spaces, and it also applies when

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainer using any of the [private contact addresses](https://github.com/metaloha/ts-boilerplate#support). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project maintainer using any of the [private contact addresses](https://github.com/russelporosky/ts-boilerplate#support). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ To set up a development environment, please follow these steps:
1. Clone the repo

```shell
git clone https://github.com/metaloha/ts-boilerplate
git clone https://github.com/russelporosky/ts-boilerplate
```

2. Install dependencies
Expand All @@ -27,7 +27,7 @@ To set up a development environment, please follow these steps:

## Issues and feature requests

You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by submitting an issue to our [GitHub Repository](https://github.com/metaloha/ts-boilerplate/issues). Before you create an issue, make sure you search the archive, maybe your question was already answered. Also, please check out [GitHub discussions](https://github.com/metaloha/ts-boilerplate/discussions) before submitting an issue.
You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by submitting an issue to our [GitHub Repository](https://github.com/russelporosky/ts-boilerplate/issues). Before you create an issue, make sure you search the archive, maybe your question was already answered. Also, please check out [GitHub discussions](https://github.com/russelporosky/ts-boilerplate/discussions) before submitting an issue.

Please try to create bug reports that are:

Expand All @@ -41,7 +41,7 @@ Even better: You could submit a pull request with a fix or new feature!
## Pull request process

1. Search our repository for open or closed
[pull requests](https://github.com/metaloha/ts-boilerplate/pulls)
[pull requests](https://github.com/russelporosky/ts-boilerplate/pulls)
that relates to your submission. You don't want to duplicate effort.
2. Fork the project
3. Create your feature branch (`git checkout -b feat/amazing_feature`)
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# TypeScript Boilerplate

[![Build Status](https://github.com/metaloha/ts-boilerplate/actions/workflows/ci.yml/badge.svg)](https://github.com/metaloha/ts-boilerplate/actions)
[![Build Status](https://github.com/russelporosky/ts-boilerplate/actions/workflows/ci.yml/badge.svg)](https://github.com/russelporosky/ts-boilerplate/actions)

This is a lightweight TypeScript boilerplate that uses `jest` for testing, `prettier` for formatting, and `typedoc` for document generation.

Expand All @@ -14,8 +14,8 @@ Delete or rename the existing `src/HelloWorld.ts` and `src/HelloWorld.spec.ts` f

Reach out to the maintainer at one of the following places:

- [GitHub discussions](https://github.com/metaloha/ts-boilerplate/discussions)
- The email which is located [in my GitHub profile](https://github.com/metaloha)
- [GitHub discussions](https://github.com/russelporosky/ts-boilerplate/discussions)
- The email which is located [in my GitHub profile](https://github.com/russelporosky)

## Contributing

Expand All @@ -27,9 +27,9 @@ Thank you for being involved!

## Authors & contributors

The original setup of this repository is by [Russel Porosky](https://github.com/metaloha).
The original setup of this repository is by [Russel Porosky](https://github.com/russelporosky).

For a full list of all authors and contributors, check [the contributor's page](https://github.com/metaloha/ts-boilerplate/contributors).
For a full list of all authors and contributors, check [the contributor's page](https://github.com/russelporosky/ts-boilerplate/contributors).

## Security

Expand Down
2 changes: 1 addition & 1 deletion SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

If there are any vulnerabilities in the **TS-Boilerplate** project, don't hesitate to _report them_.

1. Use any of the [private contact addresses](https://github.com/metaloha/ts-boilerplate#support).
1. Use any of the [private contact addresses](https://github.com/russelporosky/ts-boilerplate#support).
2. Describe the vulnerability.

- If you have a fix, explain or attach it.
Expand Down
10 changes: 5 additions & 5 deletions documentation/classes/HelloWorld.html
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HelloWorld | ts-boilerplate - v2.4.0</title><meta name="description" content="Documentation for ts-boilerplate"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>HelloWorld | ts-boilerplate - v2.5.1</title><meta name="description" content="Documentation for ts-boilerplate"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
<div class="tsd-toolbar-contents container">
<div class="table-cell" id="tsd-search" data-base="..">
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
<div class="field">
<div id="tsd-toolbar-links"></div></div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">ts-boilerplate - v2.4.0</a></div>
<li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">ts-boilerplate - v2.5.1</a></div>
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header>
<div class="container container-main">
<div class="col-content">
Expand All @@ -24,7 +24,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">HelloWorld</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/metaloha/ts-boilerplate/blob/910d069/src/HelloWorld.ts#L10">HelloWorld.ts:10</a></li></ul></aside>
<li>Defined in <a href="https://github.com/russelporosky/ts-boilerplate/blob/5b00bf4/src/HelloWorld.ts#L10">HelloWorld.ts:10</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -69,7 +69,7 @@ <h4>Example</h4><pre><code class="language-ts"><span class="hl-0">hello</span><s
</code><button>Copy</button></pre>
</div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/metaloha/ts-boilerplate/blob/910d069/src/HelloWorld.ts#L19">HelloWorld.ts:19</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/russelporosky/ts-boilerplate/blob/5b00bf4/src/HelloWorld.ts#L19">HelloWorld.ts:19</a></li></ul></aside></li></ul></section></section></div>
<div class="col-sidebar">
<div class="page-menu">
<div class="tsd-navigation settings">
Expand All @@ -92,7 +92,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="#constructor" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a></li>
<li><a href="#hello" class=""><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>hello</span></a></li></ul></div></details></div>
<div class="site-menu">
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>ts-boilerplate - v2.4.0</span></a>
<nav class="tsd-navigation"><a href="../modules.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>ts-boilerplate - v2.5.1</span></a>
<ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base="..">
<li><a href="HelloWorld.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>HelloWorld</a></li></ul></nav></div></div></div>
<div class="tsd-generator">
Expand Down
18 changes: 9 additions & 9 deletions documentation/index.html
Original file line number Diff line number Diff line change
@@ -1,32 +1,32 @@
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ts-boilerplate - v2.4.0</title><meta name="description" content="Documentation for ts-boilerplate"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>ts-boilerplate - v2.5.1</title><meta name="description" content="Documentation for ts-boilerplate"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="assets/style.css"/><link rel="stylesheet" href="assets/highlight.css"/><script defer src="assets/main.js"></script><script async src="assets/search.js" id="tsd-search-script"></script><script async src="assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar">
<div class="tsd-toolbar-contents container">
<div class="table-cell" id="tsd-search" data-base=".">
<div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div>
<div class="field">
<div id="tsd-toolbar-links"></div></div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">ts-boilerplate - v2.4.0</a></div>
<li class="state failure">The search index is not available</li></ul><a href="index.html" class="title">ts-boilerplate - v2.5.1</a></div>
<div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-menu"></use></svg></a></div></div></header>
<div class="container container-main">
<div class="col-content">
<div class="tsd-page-title">
<h2>ts-boilerplate - v2.4.0</h2></div>
<div class="tsd-panel tsd-typography"><a id="md:typescript-boilerplate" class="tsd-anchor"></a><h1><a href="#md:typescript-boilerplate">TypeScript Boilerplate</a></h1><p><a href="https://github.com/metaloha/ts-boilerplate/actions"><img src="https://github.com/metaloha/ts-boilerplate/actions/workflows/ci.yml/badge.svg" alt="Build Status"></a></p>
<h2>ts-boilerplate - v2.5.1</h2></div>
<div class="tsd-panel tsd-typography"><a id="md:typescript-boilerplate" class="tsd-anchor"></a><h1><a href="#md:typescript-boilerplate">TypeScript Boilerplate</a></h1><p><a href="https://github.com/russelporosky/ts-boilerplate/actions"><img src="https://github.com/russelporosky/ts-boilerplate/actions/workflows/ci.yml/badge.svg" alt="Build Status"></a></p>
<p>This is a lightweight TypeScript boilerplate that uses <code>jest</code> for testing, <code>prettier</code> for formatting, and <code>typedoc</code> for document generation.</p>
<p>Delete or rename the existing <code>src/HelloWorld.ts</code> and <code>src/HelloWorld.spec.ts</code> files to reflect your preferred names.</p>
<p><code>npm run lint</code> will compare your code against the linter settings. This repository is set to use <code>tabs</code> for indentation and single quotes for strings.</p>
<p><code>npm run test</code> will run your tests. For a coverage report, use <code>npm run test:coverage</code>. And to have tests watch for changes and automatically re-run, use <code>npm run test:watch</code>.</p>
<a id="md:support" class="tsd-anchor"></a><h2><a href="#md:support">Support</a></h2><p>Reach out to the maintainer at one of the following places:</p>
<ul>
<li><a href="https://github.com/metaloha/ts-boilerplate/discussions">GitHub discussions</a></li>
<li>The email which is located <a href="https://github.com/metaloha">in my GitHub profile</a></li>
<li><a href="https://github.com/russelporosky/ts-boilerplate/discussions">GitHub discussions</a></li>
<li>The email which is located <a href="https://github.com/russelporosky">in my GitHub profile</a></li>
</ul>
<a id="md:contributing" class="tsd-anchor"></a><h2><a href="#md:contributing">Contributing</a></h2><p>First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are <strong>greatly appreciated</strong>.</p>
<p>We have set up a separate document containing our <a href="CONTRIBUTING.md">contribution guidelines</a>.</p>
<p>Thank you for being involved!</p>
<a id="md:authors-amp-contributors" class="tsd-anchor"></a><h2><a href="#md:authors-amp-contributors">Authors &amp; contributors</a></h2><p>The original setup of this repository is by <a href="https://github.com/metaloha">Russel Porosky</a>.</p>
<p>For a full list of all authors and contributors, check <a href="https://github.com/metaloha/ts-boilerplate/contributors">the contributor&#39;s page</a>.</p>
<a id="md:authors-amp-contributors" class="tsd-anchor"></a><h2><a href="#md:authors-amp-contributors">Authors &amp; contributors</a></h2><p>The original setup of this repository is by <a href="https://github.com/russelporosky">Russel Porosky</a>.</p>
<p>For a full list of all authors and contributors, check <a href="https://github.com/russelporosky/ts-boilerplate/contributors">the contributor&#39;s page</a>.</p>
<a id="md:security" class="tsd-anchor"></a><h2><a href="#md:security">Security</a></h2><p>TS-Boilerplate follows good practices of security, but 100% security can&#39;t be granted in software.
TS-Boilerplate is provided <strong>&quot;as is&quot;</strong> without any <strong>warranty</strong>. Use at your own risk.</p>
<p><em>For more info, please refer to the <a href="SECURITY.md">security</a>.</em></p>
Expand Down Expand Up @@ -63,7 +63,7 @@ <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon
<li><a href="#md:security"><span>Security</span></a></li>
<li><a href="#md:license"><span>License</span></a></li></ul></li></ul></li></ul></div></details></div>
<div class="site-menu">
<nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>ts-boilerplate - v2.4.0</span></a>
<nav class="tsd-navigation"><a href="modules.html" class="current"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1"></use></svg><span>ts-boilerplate - v2.5.1</span></a>
<ul class="tsd-small-nested-navigation" id="tsd-nav-container" data-base=".">
<li><a href="classes/HelloWorld.html"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-128"></use></svg>HelloWorld</a></li></ul></nav></div></div></div>
<div class="tsd-generator">
Expand Down
Loading

0 comments on commit 0960834

Please sign in to comment.