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 & rework README.md #1458

Merged
merged 1 commit into from
Oct 15, 2022
Merged

Cleanup & rework README.md #1458

merged 1 commit into from
Oct 15, 2022

Conversation

hboyd2003
Copy link
Contributor

@hboyd2003 hboyd2003 commented Oct 12, 2022

Fully reworked README.md to look better and work better on different sized displayed.
@ImprovedTube Stuff like Planned Features and other things are not fully filled out as I am not exactly sure what to put there.


«Improve YouTube!»

/ImprovedTube/ is a lightweight & powerful extension to improve your video experience & choice.

[Report a bug] · [Request a feature] · [Donate] · [Features]

YouTube Extension

Critiques

- recommended by by Firefox (only ~100 extensions!)
- 'Might be the best YouTube Extension Ever'
- 'enhances YouTube in meaningful ways' - 'Strong add-on, that gives full control over Youtube. Yet clear and easy '

The Oldest YouTube Extension

Since 2012 we have gradually been adding powerful yet lightweight features while maintaining the old ones
Throughout the years we have witnessed the birth and fall of numerous YouTube Extensions such as YoutubeCenter and Iridium
Big thanks ♡ to our contributors, translators, and donators for making this all possible!

YouTube Extension

Planned Features

  • Tool Tips

Major Features

  • Forced resolution
  • Custom playback speed from 0.1-8x
  • Youtube Themes
  • Video Repeat-, screenshot-, rotate-buttons
  • Pop-up player
  • Custom hotkeys anshortcuts

Development Installation

  1. Download & extract the latest version 🧪 or release
    • Safari
      1. See issue #494
    • Chrome / Brave / Edge / Vivaldi / ...
      1. Go to your Browser’s Extensions page (`chrome://extensions/`)
      2. Turn on "Developer mode"
      3. Click the "Load unpacked" button & select the extracted folder
    • Firefox / LibreWolf / Waterfox / GNUzilla / IceCat / ...
      1. Go to Add-ons (`about:addons`)
      2. Click on “Extensions” tab
      3. Click on “Debug Add-ons” (`about:debugging#/runtime/this-firefox`)
      4. Click on “Load Temporary Add-on…”
      5. Select the “manifest.json” file from unzipped folder

Work to be done

  • Documentation, wiki, screenshots and videos
  • Label issues
  • 🐞 Verify bug reports

🌎 Translators

Bahasa Indonesia:Bagus23,A.Muttaqin
✔️ Deutsch:Termuellinator,css-smueller
✔️ English (UK):KorbinCode
Español:Kioraga,Compvictor,dimateos
Français:leghort,Eymiks,Solvabl
Hrvatski:mbeara
✔️ Italiano:urfausto
Nederlands:aron-hoogeveen,Vistaus
Norsk:master3395,comradekingu
Norsk Bokmål:comradekingu
✔️ Polski:FluidExtractor
Português:DrNopt
✔️ Português (Brasil):dthiago,Mike-Correa
DavidBrazSan
Română:hateofhades
සිංහල (Sri Lanka):AshenNethsara
Slovenčina:bbc-s
Türkçe:onurdumangoz,daswareinfach
Thai:______ (you?)
Vietnamese:zeref-dragneel (you?)
Русский:qweered,alexesprit
ελληνικά:molyvius
العربية:Raayib
हिन्दी:monishamandal02,BRAVO68WEB
✔️ বাংলা:BRAVO68WEB
✔️ 中文 (简体):niceRAM,ausers
✔️ 中文 (繁體):Still34,water903,suitangi
✔️ 日本語:utuhiro78
한국어:msc9533,LYHyoung
(= Russian, Greek, Arabian, Hindi, Bengali
Chinese, Taiwanese, Japanese, Korean)
More languages: Filipino, Malay, Punjabi, ...
= missing some additions/updates

Our Other Extensions/Projects

Extensions Library
  • Satus - Powerful UI Library
Other
Do you need help running a large extension, site, app or repo? We'd love to help email projects@improvedtube.com for more information!

ImprovedTube added a commit that referenced this pull request Oct 13, 2022
ImprovedTube added a commit that referenced this pull request Oct 14, 2022
@ImprovedTube ImprovedTube merged commit 5f4ca9f into code-charity:master Oct 15, 2022
ImprovedTube pushed a commit that referenced this pull request Oct 15, 2022
This reverts commit 01070ac.
@ImprovedTube
Copy link
Member

@hboyd2003 sure, can still accept the PR and redo potential edits. Might first clear all obsolete/redundant commit history of readme.md

@hboyd2003
Copy link
Contributor Author

@ImprovedTube Why was it reverted?

@hboyd2003
Copy link
Contributor Author

hboyd2003 commented Oct 16, 2022

@ImprovedTube I'm confused at what you did. Did you merge the pull request then just copy and paste the old one?

I had reorganized the README.md with tabs and fixed many dead links and fixed reworked many of the paragraphs to make more sense... Most of which is not in the new README.md. Could you go back to my version an I'll add the changes you made. Then you add what else you want?

@hboyd2003
Copy link
Contributor Author

@ImprovedTube

  could be useful if you had to try without %, px or em
Ah! That's very useful I didn't know that's what you where using in place of that's. I spent an hour trying to get the tables to be smaller. I'll do some testing and see if I can put them back in.

@ImprovedTube
Copy link
Member

@hboyd2003 seen all 🤩 thank you. not seriously attached to the spaces 😆
just wanted to remove the ~800 obsolete historic commits of readme.md before accepting the PR

ImprovedTube added a commit that referenced this pull request Oct 16, 2022
@hboyd2003
Copy link
Contributor Author

@ImprovedTube So, should I make a new pull request?

ImprovedTube added a commit that referenced this pull request Oct 17, 2022
@ImprovedTube
Copy link
Member

ImprovedTube commented Oct 17, 2022

yes @hboyd2003 can/will accept every PR now, to document them properly
(can also go back to your version from now for now)
(and/or can make you a maintainer later)
Looking forward to see you as a top 2 contributor, now that the number of commits is fixed.

Readme.md:
  • replaced your <ul><li> with markdown lists. (this works with a line break above)

  • commented the current state with 😃
    <!-- * * * * * * * * * * -->
    <!-- For quick editing, -->
    <!-- text appears at the start of lines -->
    <!-- while html appears at the end -->
    <!-- * * * * * * * * * * -->

  • The Translator (Credits) table is mainly to feature the Github names, will try also shortening the language names to the ISO codes (and requires less width without the <code> around the check.) 🤔

  • Projects list:

    • the regex replace repo has to be created from the Webstore Version
    • the striked through ones are not currently online, which doesn't make them less relevant for who reads that far
      ( will still fill gaps)

@hboyd2003
Copy link
Contributor Author

@ImprovedTube

Looking forward to see you as a top 2 contributor, now that the number of commits is fixed.

I hope so!

Readme.md:

Most of my cleanup still has been removed.... (and my commit that cleaned everything up and rework was never merged) Go to my version and turn off word-wrap and you'll should see all the cleanup I did.

Just delete my commit and I'll implement the changes you made and make a new pr. Then you can edit it to make it how you want.

ImprovedTube added a commit that referenced this pull request Oct 18, 2022
@ImprovedTube
Copy link
Member

ImprovedTube commented Oct 18, 2022

Watched (read) your code a few times since october 12th & liked all your thoughts.
Now both have advantages 😳 & Didn't mean to keep you busy here as fixing bugs (preparing the next release) matters more

(

  • Features list is hard to preview
  • "ToDo" could be something inbetween old and and new
  • the old "Our Projects" is much shorter now
    • or could make it a table with 3 columns
  • Or maybe should make/keep all simpler like your suggestion
    )

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