diff options
| -rw-r--r-- | README.md | 6 | ||||
| -rw-r--r-- | api/doc.go | 10 | ||||
| -rw-r--r-- | cli/doc.go | 10 | ||||
| -rw-r--r-- | config/doc.go | 10 | ||||
| -rw-r--r-- | crypto/doc.go | 10 | ||||
| -rw-r--r-- | daemon/doc.go | 10 | ||||
| -rw-r--r-- | doc.go | 10 | ||||
| -rw-r--r-- | duration/doc.go | 10 | ||||
| -rw-r--r-- | errors/doc.go | 10 | ||||
| -rw-r--r-- | fever/doc.go | 10 | ||||
| -rw-r--r-- | filter/doc.go | 10 | ||||
| -rw-r--r-- | http/doc.go | 10 | ||||
| -rw-r--r-- | integration/doc.go | 10 | ||||
| -rw-r--r-- | locale/doc.go | 10 | ||||
| -rw-r--r-- | logger/doc.go | 10 | ||||
| -rw-r--r-- | model/doc.go | 10 | ||||
| -rw-r--r-- | oauth2/doc.go | 10 | ||||
| -rw-r--r-- | reader/doc.go | 10 | ||||
| -rw-r--r-- | scheduler/doc.go | 10 | ||||
| -rw-r--r-- | sql/doc.go | 10 | ||||
| -rw-r--r-- | storage/doc.go | 10 | ||||
| -rw-r--r-- | template/doc.go | 10 | ||||
| -rw-r--r-- | timer/doc.go | 10 | ||||
| -rw-r--r-- | ui/doc.go | 10 | ||||
| -rw-r--r-- | url/doc.go | 10 | ||||
| -rw-r--r-- | url/url_test.go | 4 | ||||
| -rw-r--r-- | version/doc.go | 10 | ||||
| -rw-r--r-- | version/version.go | 2 |
28 files changed, 256 insertions, 6 deletions
@@ -1,6 +1,7 @@ Miniflux 2 ========== [](https://travis-ci.org/miniflux/miniflux) +[](https://godoc.org/github.com/miniflux/miniflux) [](https://docs.miniflux.net/) Miniflux is a minimalist and opinionated feed reader: @@ -16,11 +17,6 @@ It's simple, fast, lightweight and super easy to install. Miniflux 2 is a rewrite of [Miniflux 1.x](https://github.com/miniflux/miniflux-legacy) in Golang. -Notes ------ - -Miniflux 2 still in development and **it's not ready to use**. - Documentation ------------- diff --git a/api/doc.go b/api/doc.go new file mode 100644 index 0000000..a43e463 --- /dev/null +++ b/api/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package api implements API endpoints for Miniflux application. + +*/ +package api diff --git a/cli/doc.go b/cli/doc.go new file mode 100644 index 0000000..9d4954f --- /dev/null +++ b/cli/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package cli implements command line arguments for Miniflux application. + +*/ +package cli diff --git a/config/doc.go b/config/doc.go new file mode 100644 index 0000000..f2e9211 --- /dev/null +++ b/config/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package config handles configuration values for Miniflux application. + +*/ +package config diff --git a/crypto/doc.go b/crypto/doc.go new file mode 100644 index 0000000..2bca85a --- /dev/null +++ b/crypto/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package crypto implements helpers related to cryptography. + +*/ +package crypto diff --git a/daemon/doc.go b/daemon/doc.go new file mode 100644 index 0000000..e246949 --- /dev/null +++ b/daemon/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package daemon handles the main application process. + +*/ +package daemon @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package main implements a feed reader application. + +*/ +package main diff --git a/duration/doc.go b/duration/doc.go new file mode 100644 index 0000000..8fc5296 --- /dev/null +++ b/duration/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package duration implements helpers to calculate time duration. + +*/ +package duration diff --git a/errors/doc.go b/errors/doc.go new file mode 100644 index 0000000..4c3114d --- /dev/null +++ b/errors/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package errors handles localized errors. + +*/ +package errors diff --git a/fever/doc.go b/fever/doc.go new file mode 100644 index 0000000..f01f098 --- /dev/null +++ b/fever/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package fever implements Fever API endpoints. + +*/ +package fever diff --git a/filter/doc.go b/filter/doc.go new file mode 100644 index 0000000..5fd9fef --- /dev/null +++ b/filter/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package filter implements a content filter to rewrite image links. + +*/ +package filter diff --git a/http/doc.go b/http/doc.go new file mode 100644 index 0000000..f0eb1fa --- /dev/null +++ b/http/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package http implements a set of utilities related to the HTTP protocol. + +*/ +package http diff --git a/integration/doc.go b/integration/doc.go new file mode 100644 index 0000000..fb1fc08 --- /dev/null +++ b/integration/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package integration implements API clients for third-party services. + +*/ +package integration diff --git a/locale/doc.go b/locale/doc.go new file mode 100644 index 0000000..5e92c6f --- /dev/null +++ b/locale/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package locale handles the internationalization of the application. + +*/ +package locale diff --git a/logger/doc.go b/logger/doc.go new file mode 100644 index 0000000..4d63bcd --- /dev/null +++ b/logger/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package logger handles application log messages with different levels. + +*/ +package logger diff --git a/model/doc.go b/model/doc.go new file mode 100644 index 0000000..4718d8a --- /dev/null +++ b/model/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package model contains all data structures used by the application. + +*/ +package model diff --git a/oauth2/doc.go b/oauth2/doc.go new file mode 100644 index 0000000..2254a3f --- /dev/null +++ b/oauth2/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package oauth2 abstracts different OAuth2 providers. + +*/ +package oauth2 diff --git a/reader/doc.go b/reader/doc.go new file mode 100644 index 0000000..1698644 --- /dev/null +++ b/reader/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package reader implements everything related to feed parsing. + +*/ +package reader diff --git a/scheduler/doc.go b/scheduler/doc.go new file mode 100644 index 0000000..ea5becc --- /dev/null +++ b/scheduler/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package scheduler implements the application internal scheduler. + +*/ +package scheduler diff --git a/sql/doc.go b/sql/doc.go new file mode 100644 index 0000000..2096efc --- /dev/null +++ b/sql/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package sql contains all SQL queries or database schema instructions. + +*/ +package sql diff --git a/storage/doc.go b/storage/doc.go new file mode 100644 index 0000000..aede4e8 --- /dev/null +++ b/storage/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package storage implements a set of functions to interact with the database. + +*/ +package storage diff --git a/template/doc.go b/template/doc.go new file mode 100644 index 0000000..5bdae47 --- /dev/null +++ b/template/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package template handles template parsing and execution. + +*/ +package template diff --git a/timer/doc.go b/timer/doc.go new file mode 100644 index 0000000..8d330ae --- /dev/null +++ b/timer/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package timer implements utility functions to measure the execution time of a block of code. + +*/ +package timer diff --git a/ui/doc.go b/ui/doc.go new file mode 100644 index 0000000..30154e9 --- /dev/null +++ b/ui/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package ui implements handlers to render to user interface. + +*/ +package ui diff --git a/url/doc.go b/url/doc.go new file mode 100644 index 0000000..e7ddf89 --- /dev/null +++ b/url/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package url implements a set of utility functions to parse URL. + +*/ +package url diff --git a/url/url_test.go b/url/url_test.go index 13c723a..12e131f 100644 --- a/url/url_test.go +++ b/url/url_test.go @@ -1,3 +1,7 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the Apache 2.0 +// license that can be found in the LICENSE file. + package url import "testing" diff --git a/version/doc.go b/version/doc.go new file mode 100644 index 0000000..fd58a6d --- /dev/null +++ b/version/doc.go @@ -0,0 +1,10 @@ +// Copyright 2018 Frédéric Guillot. All rights reserved. +// Use of this source code is governed by the MIT license +// that can be found in the LICENSE file. + +/* + +Package version contains application and build information. + +*/ +package version diff --git a/version/version.go b/version/version.go index 0724730..4f76433 100644 --- a/version/version.go +++ b/version/version.go @@ -4,7 +4,7 @@ package version -// Version of the application (generate with "make build") +// Version of the application (generated with "make build") var Version = "undefined" // BuildDate is generated with "make build" |