README.now
Your README is influence
Gant
@GantLaborde
Infinite Red
Gant
Infinite Red
Contributor to 100s of projects with 100s of stars
🌟
Â
Core on projects with thousands
WHY?
WHY?
Are README files even important?
?
WHY?
In Open Source
Â
A Scalable solution for:
- Explain "Why"
- Explain "What"
- Get Users
- Get Contributors
- Make Impression
- For Self
WHY?
In Closed Source
Â
A Scalable solution for:
- Explain "Why"
- Explain "What"
- Get Users
- Get Contributors
- Make Impression
- For Self
WHY?
You're either good at communicating
Â
OR
Â
You're bad at communicating
Agree or Disagree
This is important some day
Goals
Standing Out
Keeping Attention
Super Secret Sauceâ„¢
A Case Study
A Case Study
install-subset
A Case Study
install-subset
What kind of things can we add?
A Case Study
A Case Study
install-subset
- Sniff Test
- Advanced Version Numbers
- Projects that Use this
- Keep it fun
- Mention Standards/Paradigms
- Mention Contributors
- Good SEO
- Companion Social Media
Common Tools
Every Readme Could Use
Common Tools
Every Readme Could Use
The LOGO
Common Tools
Every Readme Could Use
The Badges
Common Tools
Every Readme Could Use
A Call to Action
Advanced Docs, Social, Playgrounds Etc.
Common Tools
Every Readme Could Use
README reviewers
Common Tools
Every Readme Could Use
All-Contributors Section
Common Tools
Every Readme Could Use
Others?
Another Case Study
Another Case Study
Another Case Study
Another Case Study
You can see it...
Another Case Study
Your Readme is Influence
You're always playing
One Last Thing
Super Secret Sauceâ„¢
One Last Thing
The One Thing that sets a README on fire 🔥
GIFS
One Last Thing
NOT THE GIFS!!!!
One Last Thing
TRUTH!
One Last Thing
One Last Thing
The Secret Sauce
GIFs work
One Last Thing
A Great GIF is worth a thousand stars
- Gant
README.NOW
@GantLaborde
Slides
https://slides.com/gantlaborde/readmenow
