Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup README.md: Fixing some typos/bugs and etc. #17

Merged
merged 2 commits into from
Jun 12, 2023

Conversation

patricknelson
Copy link
Contributor

@patricknelson patricknelson commented Jun 6, 2023

Cleanup README.md:

  • Fixing some typos/bugs
  • Capitalizing Svelte
  • Overall helping make it more informative

Preview the way it looks here: https://github.com/patricknelson/svelte-tag/tree/adjust-readme

README.md Outdated Show resolved Hide resolved
@patricknelson patricknelson changed the title Cleanup README.md: Fixing some typos/bugs and etc. [WIP] Cleanup README.md: Fixing some typos/bugs and etc. Jun 6, 2023
@patricknelson patricknelson changed the title [WIP] Cleanup README.md: Fixing some typos/bugs and etc. Cleanup README.md: Fixing some typos/bugs and etc. Jun 6, 2023
@patricknelson patricknelson marked this pull request as draft June 6, 2023 04:25
@patricknelson patricknelson marked this pull request as ready for review June 6, 2023 04:25
@patricknelson
Copy link
Contributor Author

Sorry, tinkering with draft/WIP feature.

@@ -25,21 +23,27 @@ npm install svelte-tag
```

```javascript
import Component from "svelte-tag"
import SvelteTag from "svelte-tag"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was an opinionated change. In my defense, not only did I naturally want to name it SvelteTag, but apparently so have others (see dependents). Seems natural 😊, e.g. https://github.com/souriya777/elegant-seo-website/blob/main/_dev/src/js/svelte-elements.js

@crisward crisward merged commit eaf6a28 into crisward:master Jun 12, 2023
1 check passed
import App from "your-app.svelte"
new Component({component:App,tagname:"hello-world",href="/your/stylesheet.css",attributes:["name"]})

new SvelteTag({
Copy link
Contributor Author

@patricknelson patricknelson Jun 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

p.s. @crisward It didn’t notice this until a fair bit later after this PR, but it turns out the use of new here is not necessary at all.

@patricknelson patricknelson deleted the adjust-readme branch June 12, 2023 23:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants