Shared Vanity Go URLs (SVGU)
============================

SVGU is a quick and efficient solution tool to create and share Go modules on
your own domain.

For illustration, let take the Go module hosted on GitHub at
https://github.com/nc0fr/foo-go. Using SVGU, the module can be named using
my own domain (go.nc0.fr) and imported via go.nc0.fr/foo.


Getting started
---------------

You can install SVGU via Homebrew, using the Go toolchain, or compiling from
sources.

Homebrew:

    $ brew install nc0fr/nc0/svgu

Go:

    $ go install go.nc0.fr/svgu@latest

Compiling from sources (requires Go, Git and Make):

    $ git clone https://github.com/nc0fr/svgu.git
    $ cd svgu
    $ make

Please refer to the online documentation (https://svgu.nc0.fr) for more
information.

License
-------

Copyright 2023 Nicolas Paul.

SVGU is a free software licensed under the CeCILL 2.1 license, which text is
available both in French and English inside the LICENSE-CeCILL files.
The software documentation is made available under the Creative Commons
Attribution ShareAlike 4.0 (CC-BY-SA 4.0) license.

Please read the LICENSE file.

The following header notice must be placed at the top of every applicable
file licensed under our BSD license:

  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.