Skip to content

Commit de3872e

Browse files
committed
Updated readme with some corrections.
1 parent 7a3a45f commit de3872e

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
**go-links** is a stand-along server that lets you set a keyword to get to an
2+
**go-links** is a stand-alone HTTP server that lets you set a keyword to get to an
33
URL. This is not a URL shortener which takes a URL that generates a shorter
44
link, but lets you specify a short and easy-to-remember word to use so that if
55
you type something like `go/hr` then it might direct you to your company's HR
@@ -35,20 +35,22 @@ The basics features of go-links are:
3535
URL.
3636
* When user uses an unknown keyword, they get directed to a form to create a new
3737
go link.
38+
* Supports HTTPS.
39+
* Uses oAuth2 for user authentication (initially with Google accounts)
40+
* Support sessions.
3841

3942
Other features:
4043

4144
* Simple deployment - go-links is a single binary.
42-
* Uses oAuth2 for user authentication (initially with Google accounts)
43-
* Support sessions.
4445
* Simple code so that people can easily modify it for their needs.
4546
* go-links is not meant to be library for building go link services.
4647
* Simple to build and compile - go-links is built using the Go programming
4748
langauge (no relations) and uses all native Go code.
4849

49-
NOTE: go-links is not meant for large enterprises with 100k users. I've not
50-
optimized for that scale. This is meant for my needs but thought it might be
51-
helpful for others so I wanted to make the code available.
50+
NOTE: go-links is not meant for large enterprises with thousands of users. This
51+
was a weekend project tailored for my needs but I did want to make it simple and
52+
easy to understand (and therefore easy to modify) for those looking for
53+
something similar.
5254

5355
## Installation
5456

@@ -87,12 +89,14 @@ will show the different parameters.
8789
## Browser Extension
8890

8991
I have a [simple browser
90-
extension](https://github.com/lazyhacker/go-links-chrome-extension) to rewrite go/ to the go-link server if the
91-
machine's host settings can't be modified.
92+
extension](https://github.com/lazyhacker/go-links-chrome-extension) to rewrite
93+
go/ to the go-link server if the machine's host settings can't be modified.
9294

9395
## TODO
9496

9597
- memory cache
9698
- link transfer
9799
- refactor hard-coded strings
100+
- have a HTTP middle-ware so channels can be shared instead of being a package
101+
variable.
98102

0 commit comments

Comments
 (0)