Organize some comment

Author: suhaibmujahid

README.md

@@ -1,10 +1,18 @@
 # go-bitbucket-server
-go-bitbucket-server is a Go client library for accessing the Bitbucket Server API v1.
 
-> This client is under development , I started with endpoints that is important to me. The goal eventually is to cover the all endpoints. Pull requests are welcomed to implement missed endpoints or fix bugs.  
+go-bitbucket-server is a [Go](https://golang.orgs) client library for accessing the 
+[Bitbucket](https://www.atlassian.com/software/bitbucket) Server API v1.
+
+> This client is under development , I started with endpoints that is important to me.
+> The goal eventually is to cover the all endpoints.
+> Pull requests are welcomed to implement missed endpoints or fix bugs.  
+
+The interface design of this package was inspired by [google/go-github](https://github.com/google/go-github) 
+and [andygrunwald/go-jira](https://github.com/andygrunwald/go-jira).
+
+
+## Usage
 
- ## Usage
- 
 ```go
 import "github.com/suhaibmujahid/go-bitbucket-server/bitbucket"
 

bitbucket/event_types.go

@@ -2,6 +2,15 @@ package bitbucket
 
 import "time"
 
+// todo: the following are the missed event types:
+//  * mirror:repo_synchronized
+//  * pr:comment:added
+//  * pr:comment:edited
+//  * pr:comment:deleted
+//  * repo:comment:added
+//  * repo:comment:edited
+//  * repo:comment:deleted
+
 const (
 	EventKeyRepositoryPush              = "repo:refs_changed"
 	EventKeyRepositoryModified          = "repo:modified"
@@ -175,12 +184,3 @@ type PullRequestReviewerEvent struct {
 	Participant    *PullRequestUser `json:"participant"`
 	PreviousStatus string           `json:"previousStatus"`
 }
-
-// todo: the following are the missed event types:
-//  * mirror:repo_synchronized
-//  * pr:comment:added
-//  * pr:comment:edited
-//  * pr:comment:deleted
-//  * repo:comment:added
-//  * repo:comment:edited
-//  * repo:comment:deleted

bitbucket/messages.go

@@ -1,3 +1,6 @@
+// This file provides functions for validating payloads from Bitbucket Server Webhooks.
+// Doc: https://confluence.atlassian.com/bitbucketserver070/managing-webhooks-in-bitbucket-server-996644364.html
+
 package bitbucket
 
 import (