Publish: Sitemap Protocol for Go.

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+# These owners will be the default owners for everything in the repo.
+*       @kataras

.github/FUNDING.yml

@@ -0,0 +1,2 @@
+custom: https://iris-go.com/donate
+# github: kataras

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,8 @@
+Examples for the `sitemap` project can be found at
+<https://github.com/kataras/sitemap/tree/master/_examples>.
+
+Documentation for the `sitemap` project can be found at
+<https://godoc.org/github.com/kataras/sitemap>.
+
+Love the `sitemap` package? Please consider supporting the project:
+👉  https://paypal.me/kataras

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG]"
+labels: type:bug
+assignees: kataras
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. [...]
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. ubuntu, windows]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,10 @@
+---
+name: Custom issue template
+about: Other
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+Describe the issue you are facing or ask for help

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE REQUEST]"
+labels: type:idea
+assignees: kataras
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,5 @@
+# We'd love to see more contributions
+
+Read how you can [contribute to the project](https://github.com/kataras/blob/master/CONTRIBUTING.md).
+
+> Please attach an [issue](https://github.com/kataras/sitemap/issues) link which your PR solves otherwise your work may be rejected.

.gitignore

@@ -0,0 +1,2 @@
+.vscode
+# go.sum

.travis.yml

@@ -0,0 +1,20 @@
+language: go
+os:
+  - linux
+  - osx
+go:
+  - 1.13.x
+go_import_path: github.com/kataras/sitemap
+env:
+ global:
+   - GO111MODULE=on
+install:
+  - go get ./...
+script:
+  - go test -vet=off -v -cover ./...
+after_script:
+  # examples
+  - cd ./_examples
+  - go get ./...
+  - go test -vet=off -v -cover ./...
+  - cd ../

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at kataras2006@hotmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing
+
+First of all read our [Code of Conduct](https://github.com/kataras/sitemap/blob/master/CODE_OF_CONDUCT.md).
+
+## PR
+
+1. Open a new [issue](https://github.com/kataras/sitemap/issues/new)
+    * Write version of your local Go programming language.
+    * Describe your problem, what did you expect to see and what you see instead.
+        * If it's a feature request, describe your idea as better as you can
+2. Fork the [repository](https://github.com/kataras/sitemap).
+3. Make your changes.
+4. Compare & Push the PR from [here](https://github.com/kataras/sitemap/compare).

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Gerasimos Maropoulos <kataras2006@hotmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,40 @@
+# Sitemap (Go)
+
+[![build status](https://img.shields.io/travis/kataras/sitemap/master.svg?style=for-the-badge&logo=travis)](https://travis-ci.org/kataras/sitemap) [![report card](https://img.shields.io/badge/report%20card-a%2B-ff3333.svg?style=for-the-badge)](https://goreportcard.com/report/github.com/kataras/sitemap) [![godocs](https://img.shields.io/badge/go-%20docs-488AC7.svg?style=for-the-badge)](https://godoc.org/github.com/kataras/sitemap) [![donate on PayPal](https://img.shields.io/badge/support-PayPal-blue.svg?style=for-the-badge)](https://www.paypal.me/kataras)
+
+[Sitemap Protocol](https://www.sitemaps.org/protocol.html) implementation for Go. Automatically handles [Sitemap index files](https://www.sitemaps.org/protocol.html#index) `"/sitemap.xml"`.
+
+## Getting started
+
+The only requirement is the [Go Programming Language](https://golang.org/dl).
+
+```sh
+$ go get github.com/kataras/sitemap
+```
+
+```go
+import "github.com/kataras/sitemap"
+```
+
+```go
+sitemaps := sitemap.New("http://localhost:8080").
+    URL(sitemap.URL{Loc: "/home"}).
+    URL(sitemap.URL{Loc: "/articles", LastMod: time.Now(), ChangeFreq: sitemap.Daily, Priority: 1}).
+    Build()
+```
+
+```go
+import "net/http"
+```
+
+```go
+for _, s := range sitemaps {
+    http.Handle(s.Path, s)
+}
+```
+
+For a more detailed technical documentation you can head over to our [godocs](https://godoc.org/github.com/kataras/sitemap). And for executable code you can always visit the [_examples](_examples) repository's subdirectory.
+
+## License
+
+kataras/sitemap is free and open-source software licensed under the [MIT License](https://tldrlegal.com/license/mit-license).

_examples/basic/main.go

@@ -0,0 +1,38 @@
+package main
+
+import (
+	"fmt"
+	"net/http"
+	"time"
+
+	"github.com/kataras/sitemap"
+)
+
+func main() {
+	mux := http.NewServeMux()
+	mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
+		w.Write([]byte(r.URL.Path))
+	})
+
+	sitemaps := sitemap.New("http://localhost:8080").
+		URL(sitemap.URL{Loc: "/home"}).
+		URL(sitemap.URL{Loc: "/articles", LastMod: time.Now(), ChangeFreq: sitemap.Daily, Priority: 1}).
+		URL(sitemap.URL{Loc: "/about"}).
+		URL(sitemap.URL{Loc: "/rss", ChangeFreq: sitemap.Always}).
+		Build()
+
+	for _, s := range sitemaps {
+		fmt.Printf("Pos: %d\nPath: %s\nIsSitemapIndex: %v\n",
+			s.Pos, s.Path, s.IsSitemapIndex)
+
+		// http://localhost:8080/sitemap.xml
+		// When more than 50000 URLs are registered then
+		// we have more than one handler to register here
+		// with paths like: http://localhost:8080/sitemap1.xml ...sitemap%d.xml.
+		// Read more at: https://www.sitemaps.org/protocol.html
+		mux.Handle(s.Path, s)
+	}
+
+	// http://localhost:8080/sitemap.xml
+	http.ListenAndServe(":8080", mux)
+}

doc.go

@@ -0,0 +1,21 @@
+/*
+Source code and other details for the project are available at GitHub:
+
+   https://github.com/kataras/sitemap
+
+Current Version
+
+0.0.3
+
+Installation
+
+The only requirement is the Go Programming Language
+
+    $ go get github.com/kataras/sitemap
+
+Examples
+
+   https://github.com/kataras/sitemap/tree/master/_examples
+*/
+
+package sitemap

go.mod

@@ -0,0 +1,3 @@
+module github.com/kataras/sitemap
+
+go 1.13