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

docs: init README.mds & package.json #243

Merged
merged 7 commits into from
Jan 27, 2024
Merged

Conversation

davidlj95
Copy link
Owner

@davidlj95 davidlj95 commented Jan 27, 2024

Everything's ready for releasing first version. But first, we need to sell it good. Explain why the lib is useful, how to use it, some cool badges, a logo, etc... A bit of dev marketing hehe

Starting here by:

  • Updating root README.md to point to ngx-meta lib
  • Update ngx-meta README.md with:
    • Logo
    • Description
    • Cool badges
    • Basic usage
    • TODOs of docs
  • Update ngx-meta package.json with description, homepage, ... Also some sorting so it matches docs order

Also adding a scope to ignore Inkscape SVG warnings/errors for logo

Copy link
Owner Author

Current dependencies on/for this PR:

This stack of pull requests is managed by Graphite.

Copy link

github-actions bot commented Jan 27, 2024

📦 Bundle size (Angular v16)

Git ref: 8afca3d

Module file Size Base size Difference
ngx-meta-core.mjs 3250 bytes (3.2KiB) Not available Not available
ngx-meta-json-ld.mjs 392 bytes (392B) Not available Not available
ngx-meta-open-graph.mjs 1232 bytes (1.3KiB) Not available Not available
ngx-meta-routing.mjs 990 bytes (990B) Not available Not available
ngx-meta-standard.mjs 901 bytes (901B) Not available Not available
ngx-meta-twitter-card.mjs 661 bytes (661B) Not available Not available
Total 7426 bytes (7.3KiB) Not available Not available

Base size data is not available yet. Try again when the CI/CD has finished running on main branch

Copy link

github-actions bot commented Jan 27, 2024

📦 Bundle size (Angular v15)

Git ref: 8afca3d

Module file Size Base size Difference
ngx-meta-core.mjs 3250 bytes (3.2KiB) Not available Not available
ngx-meta-json-ld.mjs 392 bytes (392B) Not available Not available
ngx-meta-open-graph.mjs 1232 bytes (1.3KiB) Not available Not available
ngx-meta-routing.mjs 990 bytes (990B) Not available Not available
ngx-meta-standard.mjs 901 bytes (901B) Not available Not available
ngx-meta-twitter-card.mjs 661 bytes (661B) Not available Not available
Total 7426 bytes (7.3KiB) Not available Not available

Base size data is not available yet. Try again when the CI/CD has finished running on main branch

Copy link

github-actions bot commented Jan 27, 2024

📦 Bundle size (Angular v17)

Git ref: 8afca3d

Module file Size Base size Difference
ngx-meta-core.mjs 2846 bytes (2.8KiB) Not available Not available
ngx-meta-json-ld.mjs 226 bytes (226B) Not available Not available
ngx-meta-open-graph.mjs 888 bytes (888B) Not available Not available
ngx-meta-routing.mjs 814 bytes (814B) Not available Not available
ngx-meta-standard.mjs 784 bytes (784B) Not available Not available
ngx-meta-twitter-card.mjs 501 bytes (501B) Not available Not available
Total 6059 bytes (6.0KiB) Not available Not available

Base size data is not available yet. Try again when the CI/CD has finished running on main branch

@davidlj95 davidlj95 changed the title docs: first README.md docs: init README.mds & package.json Jan 27, 2024
@davidlj95 davidlj95 marked this pull request as ready for review January 27, 2024 04:35
@davidlj95 davidlj95 enabled auto-merge (squash) January 27, 2024 04:35
@davidlj95 davidlj95 enabled auto-merge (squash) January 27, 2024 04:35
@davidlj95 davidlj95 merged commit 048dccc into main Jan 27, 2024
10 checks passed
@davidlj95 davidlj95 deleted the stacked/docs-first-README.md branch January 27, 2024 04:36
Copy link

🎉 This PR is included in version 1.0.0-alpha.37 🎉

The release is available on:

Your semantic-release bot 📦🚀

@davidlj95 davidlj95 linked an issue Jan 27, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs
1 participant