Skip to content

README.md

Latest commit

 

History

History
68 lines (41 loc) · 1.89 KB

README.md

File metadata and controls

68 lines (41 loc) · 1.89 KB

Push

Personal URL Shortener

It's nice to have URLs that are easy to pass around on social media and via email. People are growing ever more distrustful of populate services like bit.ly, goo.gl, and tinyurl. So, I'm creating this to have a privacy-respecting alternative.

Version

The current version is 0.0.0. This project uses semantic versioning.

Contents

Features

  • Remove tracking information before saving the URL
  • Use a custom alias (Up to 16 characters)
  • Unfurl other tracking service URLs; Add option to re-shorten and save it

Questions

  • Do I want to deal with mulitple users?
  • Do I want to (Can I) manage this as a open source project?
  • What Domain Name do I want to use for my short links? Thinking awoods.info

Ideas for sections/pages

  • Language Translations
  • Frequently Asked Questions (FAQ)
  • Screenshots
  • Submit Issues

Installation

  • Put your code into src
  • Create a Git Ignore file
    • Add the phpdocs directory to your .gitignore file
    • Add Editor-specific files to your .gitignore ( .swp for Vim, .idea for PHPStorm, etc. )
  • Select an Open Source License and copy it to LICENSE.txt
  • Update CONTRIBUTING.md to match your project needs

Resources

Credits and Acknowledgments