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

Add Tiny JS #2571

Merged
merged 3 commits into from May 19, 2023
Merged

Add Tiny JS #2571

merged 3 commits into from May 19, 2023

Conversation

thoughtspile
Copy link
Contributor

https://github.com/thoughtspile/awesome-tiny-js#readme

This is a list of small frontend libraries — mostly under 2Kb, with exceptions for select categories. Smaller frontend libraries help you build smaller apps, resulting in better user experience and fewer wasted resources. Apart from production usage:

  • A well-organized list of small libraries helps open-source developers focus their efforts on fields that are not already well-covered.
  • The cruft-free code of small libraries is an excellent learning material to understand how a class of libraries works — e.g. hyperapp source is a great overview of virtual DOM.
  • Many people put considerable effort into engineering size-conscious libraries, and deserve recognition for that.

By submitting this pull request I confirm I've read and complied with the below requirements 🖖

  • Don't open a Draft / WIP pull request while you work on the guidelines. A pull request should be 100% ready and should adhere to all the guidelines when you open it. Instead use #2242 for incubation visibility.
  • Don't waste my time. Do a good job, adhere to all the guidelines, and be responsive.
  • You have to review at least 2 other open pull requests.
  • You have read and understood the instructions for creating a list.
  • This pull request has a title in the format Add Name of List. It should not contain the word Awesome.
  • Your entry here should include a short description about the project/theme of the list. It should not describe the list itself. The first character should be uppercase and the description should end in a dot. It should be an objective description and not a tagline or marketing blurb.
  • Your entry should be added at the bottom of the appropriate category.
  • The title of your entry should be title-cased and the URL to your list should end in #readme.
    • Example: - [Software Architecture](https://github.com/simskij/awesome-software-architecture#readme) - The discipline of designing and building software.
  • The suggested Awesome list complies with the below requirements.

Requirements for your Awesome list

  • Has been around for at least 30 days.
    That means 30 days from either the first real commit or when it was open-sourced. Whatever is most recent.
  • Run awesome-lint on your list and fix the reported issues. If there are false-positives or things that cannot/shouldn't be fixed, please report it.
  • The default branch should be named main, not master.
  • Includes a succinct description of the project/theme at the top of the readme. (Example)
  • It's the result of hard work and the best I could possibly produce.
  • The repo name of your list should be in lowercase slug format: awesome-name-of-list.
  • The heading title of your list should be in title case format: # Awesome Name of List.
  • Non-generated Markdown file in a GitHub repo.
  • The repo should have awesome-list & awesome as GitHub topics. I encourage you to add more relevant topics.
  • Not a duplicate. Please search for existing submissions.
  • Only has awesome items. Awesome lists are curations of the best, not everything.
  • Does not contain items that are unmaintained, has archived repo, deprecated, or missing docs. If you really need to include such items, they should be in a separate Markdown file.
  • Includes a project logo/illustration whenever possible.
    • Either centered, fullwidth, or placed at the top-right of the readme. (Example)
    • The image should link to the project website or any relevant website.
    • The image should be high-DPI. Set it to maximum half the width of the original image.
  • Entries have a description, unless the title is descriptive enough by itself. It rarely is though.
  • Includes the Awesome badge.
    • Should be placed on the right side of the readme heading.
    • Should link back to this list.
  • Has a Table of Contents section.
    • Should be named Contents, not Table of Contents.
    • Should be the first section in the list.
    • Should only have one level of nested lists, preferably none.
    • Must not feature Contributing or Footnotes sections.
  • Has an appropriate license.
    • We strongly recommend the CC0 license, but any Creative Commons license will work.
      • Tip: You can quickly add it to your repo by going to this URL: https://github.com/<user>/<repo>/community/license/new?branch=main&template=cc0-1.0 (replace <user> and <repo> accordingly).
    • A code license like MIT, BSD, Apache, GPL, etc, is not acceptable. Neither are WTFPL and Unlicense.
    • Place a file named license or LICENSE in the repo root with the license text.
    • Do not add the license name, text, or a Licence section to the readme. GitHub already shows the license name and link to the full text at the top of the repo.
    • To verify that you've read all the guidelines, please comment on your pull request with just the word unicorn.
  • Has contribution guidelines.
    • The file should be named contributing.md. Casing is up to you.
    • It can optionally be linked from the readme in a dedicated section titled Contributing, positioned at the top or bottom of the main content.
    • The section should not appear in the Table of Contents.
  • All non-important but necessary content (like extra copyright notices, hyperlinks to sources, pointers to expansive content, etc) should be grouped in a Footnotes section at the bottom of the readme. The section should not be present in the Table of Contents.
  • Has consistent formatting and proper spelling/grammar.
    • The link and description are separated by a dash.
      Example: - [AVA](…) - JavaScript test runner.
    • The description starts with an uppercase character and ends with a period.
    • Consistent and correct naming. For example, Node.js, not NodeJS or node.js.
  • Does not use hard-wrapping.
  • Does not include a CI (e.g. GitHub Actions) badge.
    You can still use a CI for linting, but the badge has no value in the readme.
  • Does not include an Inspired by awesome-foo or Inspired by the Awesome project kinda link at the top of the readme. The Awesome badge is enough.

@thoughtspile
Copy link
Contributor Author

unicorn

readme.md Outdated Show resolved Hide resolved
readme.md Outdated
@@ -430,6 +430,7 @@
- [MDBootstrap](https://github.com/mdbootstrap/awesome-mdbootstrap#readme) - Templates, layouts, components, and widgets to rapidly build websites.
- [Master CSS](https://github.com/master-co/awesome-master-css#readme) - A virtual CSS language with enhanced syntax.
- [Hydrogen](https://github.com/shopify/awesome-hydrogen#readme) - Edge-first framework for building Shopify storefronts with React.
- [Tiny JS](https://github.com/thoughtspile/awesome-tiny-js#readme) - Frontend libraries smaller than 2 kB.

Choose a reason for hiding this comment

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

This is a great list. Maybe you can add the fact that the 2 kB includes all the dependencies making this list of libs more valuable.

Choose a reason for hiding this comment

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

Thanl you

@aabouzaid
Copy link
Contributor

It's really nice and clean list.

I just have a minor suggestion about the file names in the repo.
The casing is inconsistent where:

  • Some files are in uppercase, like: README.md.
  • Some files are in lowercase, like contributing.md .

You can use any, but my suggestion is to keep them consistent.

@aabouzaid aabouzaid mentioned this pull request Apr 10, 2023
32 tasks
@thoughtspile
Copy link
Contributor Author

It's really nice and clean list.

Thanks, that's good to hear!

You can use any, but my suggestion is to keep them consistent.

Done, all lowercase now (casing changes are tricky in git)

@Swzzd
Copy link

Swzzd commented Apr 10, 2023

image

@emmanuelgautier emmanuelgautier mentioned this pull request May 2, 2023
32 tasks
@thoughtspile
Copy link
Contributor Author

Hey @sindresorhus, is there anything else I could fix or improve here? Otherwise, maybe it's time to merge.

@sindresorhus sindresorhus merged commit 6fec0ad into sindresorhus:main May 19, 2023
1 check passed
@sindresorhus
Copy link
Owner

Tweet: https://twitter.com/awesome__re/status/1659508021482127361

@thoughtspile
Copy link
Contributor Author

Thanks, and have a nice weekend y'all ❤

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

7 participants