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.

Sign up for GitHub

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

Jump to bottom

Pimp README #551

Merged
merged 3 commits into from
Jul 19, 2024
Merged

Pimp README #551

merged 3 commits into from
Jul 19, 2024

Conversation

hynek
Copy link
Member

@hynek hynek commented Jun 28, 2024

Here's a first attempt – let's iterate.

@hynek hynek force-pushed the pimp-readme branch 3 times, most recently from 381e26a to c49dc2d Compare June 30, 2024 10:37
@hynek
Copy link
Member Author

hynek commented Jun 30, 2024 •
edited
Loading

More tagline ideas:

  • "Validation for the edges, trustworthy data structures for the business."
  • "Transforming chaos into elegant objects at the edges."
  • "Neither square brackets, nor data validation belong into business code." 🤓

Tinche
Tinche approved these changes Jul 11, 2024
View reviewed changes
Copy link
Member

@Tinche Tinche left a comment

Choose a reason for hiding this comment

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

I like it!

Do you think we should lean into functional composition as the main vehicle here or leave that for the docs proper?

README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
hynek and others added 2 commits July 18, 2024 11:03
@hynek @Tinche
Update README.md
2e047cd 
Co-authored-by: Tin Tvrtković <[email protected]>
@hynek @Tinche
Update README.md
b7914c3 
Co-authored-by: Tin Tvrtković <[email protected]>
@hynek
Copy link
Member Author

hynek commented Jul 18, 2024

Do you think we should lean into functional composition as the main vehicle here or leave that for the docs proper?

I don't think that's a mainstream-enough topic for a README. The README should entice people to find out more, not overwhelm them with a wall of text that includes words they don't understand.

@hynek hynek merged commit e2ce66b into main Jul 19, 2024
9 checks passed
@hynek hynek deleted the pimp-readme branch July 19, 2024 08:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Tinche Tinche Tinche approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@hynek @Tinche