diff --git a/.github/SECURITY.md b/.github/SECURITY.md index 564538742..3e8f91ebb 100644 --- a/.github/SECURITY.md +++ b/.github/SECURITY.md @@ -1,7 +1,7 @@ # Reporting Security Issues -We take security issues in Shoelace very seriously and appreciate your efforts to disclose your findings responsibly. +We take security issues in Web Awesome very seriously and appreciate your efforts to disclose your findings responsibly. -To report a security issue, email [cory@abeautifulsite.net](mailto:cory@abeautifulsite.net) and include "SHOELACE SECURITY" in the subject line. +To report a security issue, email [cory@fontawesome.com](mailto:cory@abeautifulsite.net) and include "WEB AWESOME SECURITY" in the subject line. We'll respond as soon as possible and keep you updated throughout the process. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c1c554ca6..eb0332d1a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contributing to Shoelace +# Contributing to Web Awesome Before contributing, please review the contributions guidelines at: diff --git a/README.md b/README.md index ef7dcf34f..6d142e026 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Shoelace +# Web Awesome A forward-thinking library of web components. @@ -23,13 +23,13 @@ Twitter: [@shoelace_style](https://twitter.com/shoelace_style) ## Shoemakers 🥾 -Shoemakers, or "Shoelace developers," can use this documentation to learn how to build Shoelace from source. You will need Node >= 14.17 to build and run the project locally. +Shoemakers, or "Web Awesome developers," can use this documentation to learn how to build Web Awesome from source. You will need Node >= 14.17 to build and run the project locally. -**You don't need to do any of this to use Shoelace!** This page is for people who want to contribute to the project, tinker with the source, or create a custom build of Shoelace. +**You don't need to do any of this to use Web Awesome!** This page is for people who want to contribute to the project, tinker with the source, or create a custom build of Web Awesome. If that's not what you're trying to do, the [documentation website](https://shoelace.style) is where you want to be. -### What are you using to build Shoelace? +### What are you using to build Web Awesome? Components are built with [LitElement](https://lit-element.polymer-project.org/), a custom elements base class that provides an intuitive API and reactive data binding. The build is a custom script with bundling powered by [esbuild](https://esbuild.github.io/). @@ -38,8 +38,8 @@ Components are built with [LitElement](https://lit-element.polymer-project.org/) Start by [forking the repo](https://github.com/shoelace-style/shoelace/fork) on GitHub, then clone it locally and install dependencies. ```bash -git clone https://github.com/YOUR_GITHUB_USERNAME/shoelace -cd shoelace +git clone https://github.com/YOUR_GITHUB_USERNAME/webawesome +cd webawesome npm install ``` @@ -63,18 +63,18 @@ npm run build ### Creating New Components -To scaffold a new component, run the following command, replacing `sl-tag-name` with the desired tag name. +To scaffold a new component, run the following command, replacing `wa-tag-name` with the desired tag name. ```bash -npm run create sl-tag-name +npm run create wa-tag-name ``` This will generate a source file, a stylesheet, and a docs page for you. When you start the dev server, you'll find the new component in the "Components" section of the sidebar. ### Contributing -Shoelace is an open source project and contributions are encouraged! If you're interesting in contributing, please review the [contribution guidelines](CONTRIBUTING.md) first. +Web Awesome is an open source project and contributions are encouraged! If you're interesting in contributing, please review the [contribution guidelines](CONTRIBUTING.md) first. ## License -Shoelace is available under the terms of the MIT license. +Web Awesome is available under the terms of the MIT license. diff --git a/cspell.json b/cspell.json index 5604aab40..2172b208f 100644 --- a/cspell.json +++ b/cspell.json @@ -166,6 +166,7 @@ "valpha", "valuenow", "valuetext", + "webawesome", "WEBP", "Webpacker", "wordmark" diff --git a/custom-elements-manifest.config.js b/custom-elements-manifest.config.js index 453627028..a9282a5ef 100644 --- a/custom-elements-manifest.config.js +++ b/custom-elements-manifest.config.js @@ -33,14 +33,14 @@ export default { plugins: [ // Append package data { - name: 'shoelace-package-data', + name: 'wa-package-data', packageLinkPhase({ customElementsManifest }) { customElementsManifest.package = { name, description, version, author, homepage, license }; } }, // Infer tag names because we no longer use @customElement decorators. { - name: 'shoelace-infer-tag-names', + name: 'wa-infer-tag-names', analyzePhase({ ts, node, moduleDoc }) { switch (node.kind) { case ts.SyntaxKind.ClassDeclaration: { @@ -68,7 +68,7 @@ export default { }, // Parse custom jsDoc tags { - name: 'shoelace-custom-tags', + name: 'wa-custom-tags', analyzePhase({ ts, node, moduleDoc }) { switch (node.kind) { case ts.SyntaxKind.ClassDeclaration: { @@ -138,7 +138,7 @@ export default { } }, { - name: 'shoelace-react-event-names', + name: 'wa-react-event-names', analyzePhase({ ts, node, moduleDoc }) { switch (node.kind) { case ts.SyntaxKind.ClassDeclaration: { @@ -156,7 +156,7 @@ export default { } }, { - name: 'shoelace-translate-module-paths', + name: 'wa-translate-module-paths', packageLinkPhase({ customElementsManifest }) { customElementsManifest?.modules?.forEach(mod => { // diff --git a/docs/_includes/component.njk b/docs/_includes/component.njk index 249f9b77e..d2153d54a 100644 --- a/docs/_includes/component.njk +++ b/docs/_includes/component.njk @@ -1,7 +1,7 @@ {% extends "default.njk" %} {# Find the component based on the `tag` front matter #} -{% set component = getComponent('sl-' + page.fileSlug) %} +{% set component = getComponent('wa-' + page.fileSlug) %} {% block content %} {# Determine the badge variant #} @@ -26,12 +26,12 @@
- + Since {{component.since or '?' }} - - + + {{ component.status }} - +
@@ -51,42 +51,42 @@ any of the following snippets to cherry pick this component.

- - Script - Import - Bundler - React + + Script + Import + Bundler + React - +

To import this component from the CDN using a script tag: 

<script type="module" src="https://cdn.jsdelivr.net/npm/@shoelace-style/shoelace@{{ meta.version }}/{{ meta.cdndir }}/{{ component.path }}"></script>
- + - +

To import this component from the CDN using a JavaScript import: 

import 'https://cdn.jsdelivr.net/npm/@shoelace-style/shoelace@{{ meta.version }}/{{ meta.cdndir }}/{{ component.path }}';
- + - +

To import this component using a bundler: 

import '@shoelace-style/shoelace/{{ meta.npmdir }}/{{ component.path }}';
- + - +

To import this component as a React component: 

import {{ component.name }} from '@shoelace-style/shoelace/{{ meta.npmdir }}/react/{{ component.tagNameWithoutPrefix }}';
- - + + {# Slots #} {% if component.slots.length %} @@ -140,13 +140,13 @@ {% if prop.attribute | length > 0 %} {% if prop.attribute != prop.name %}
- + {{ prop.attribute }} - + {% endif %} {% endif %} @@ -155,7 +155,7 @@ {% if prop.reflects %} - + {% endif %} diff --git a/docs/_includes/default.njk b/docs/_includes/default.njk index d9754194a..c6340b487 100644 --- a/docs/_includes/default.njk +++ b/docs/_includes/default.njk @@ -2,7 +2,7 @@ {# Metadata #} @@ -33,9 +33,9 @@ - {# Shoelace #} + {# Web Awesome #} - + {# Web Fonts #} @@ -74,19 +74,19 @@
- - Code - - - Star - - - Follow - + + Code + + + Star + + + Follow +
diff --git a/docs/_includes/sidebar.njk b/docs/_includes/sidebar.njk index b01d398b4..19c3e5724 100644 --- a/docs/_includes/sidebar.njk +++ b/docs/_includes/sidebar.njk @@ -40,7 +40,7 @@