diff options
Diffstat (limited to 'doc/pages/index.mdx')
| -rw-r--r-- | doc/pages/index.mdx | 64 |
1 files changed, 62 insertions, 2 deletions
diff --git a/doc/pages/index.mdx b/doc/pages/index.mdx index d5bed2b..1e2f4a7 100644 --- a/doc/pages/index.mdx +++ b/doc/pages/index.mdx @@ -1,3 +1,63 @@ -# Welcome to Nextra +--- +# Copyright Nicolas (2023) +# +# * Nicolas Paul +# +# This software is a computer program whose purpose is to allow the hosting +# and sharing of Go modules using a personal domain. +# +# This software is governed by the CeCILL license under French law and +# abiding by the rules of distribution of free software. You can use, +# modify and/ or redistribute the software under the terms of the CeCILL +# license as circulated by CEA, CNRS and INRIA at the following URL +# "http://www.cecill.info". +# +# As a counterpart to the access to the source code and rights to copy, +# modify and redistribute granted by the license, users are provided only +# with a limited warranty and the software's author, the holder of the +# economic rights, and the successive licensors have only limited +# liability. +# +# In this respect, the user's attention is drawn to the risks associated +# with loading, using, modifying and/or developing or reproducing the +# software by the user in light of its specific status of free software, +# that may mean that it is complicated to manipulate, and that also +# therefore means that it is reserved for developers and experienced +# professionals having in-depth computer knowledge. Users are therefore +# encouraged to load and test the software's suitability as regards their +# requirements in conditions enabling the security of their systems and/or +# data to be ensured and, more generally, to use and operate it in the +# same conditions as regards security. +# +# The fact that you are presently reading this means that you have had +# knowledge of the CeCILL license and that you accept its terms. + +title: Introduction +description: | + SVGU is a utility tool allowing the sharing and publication of Go modules + on personal domains easily, in a declarative manner. +--- + +# Welcome to SVGU -Hello, world! +**SVGU** (short for *shared vanity Go URLs*) is a neat command-line utility +that allows anyone to publish their Go modules on their own domains, to +obtain module names such as `example.com/foo` instead of `github.com`. + +Naming a Go module using a custom domain name avoid being trapped to the code +hosting service (such as GitHub). Indeed, you could change the host used (or +change the origin used) without requiring your users to change all their code +to the new path. + +For illustration, imagine you are using `example.com/foo` as a dependency, +whose main origin is on GitHub. If suddenly the origin is moved to GitLab +(for some particular reason), it will be transparent to you. + +## Licensing + +SVGU is a free software, available under the CeCILL 2.1 license contract. +This documentation is available under the Creative Commons +Attribution-ShareAlike 4.0 license. + +Please see the [repository](https://github.com/nc0fr/svgu) for complete +details. |