Skip to content

Commit

Permalink
Merge pull request #5 from getoslash/tanmayshah/eng-1276-write-readme
Browse files Browse the repository at this point in the history
feat: add project readme
  • Loading branch information
Naveen Aiathurai authored Nov 8, 2023
2 parents ae8daf8 + 49cd410 commit 07a9d21
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
## Objective

We are developing an open source version of the proprietary OSlash Shortcuts / GoLinks Alternative.
This would be a browser extension which can be used to convert web-urls into short links/shortcuts and access them.
The goal is to enable users to quickly manage and access all of their important links/websites.

### What is an o/ (pronounced as OSlash) shortcut ?
An o/ shortcut is a short keyword that can be entered directly into your browser’s address bar to quickly access web resources.

### How to use o/ shortcuts ?
o/ shortcuts can be used by first installing a browser extension in your browser. Then one can add the url and their associated o/ shortcut via the browser extension UI interface.
Once saved, this o/ shortcut can then be entered directly into the browser’s address bar by the user.

## Motivation

Purpose of releasing this open source version is to give out a minimal and stable release of OSlash Shortcuts.

0 comments on commit 07a9d21

Please sign in to comment.