Add README files

4 files changed, 76 insertions, 45 deletions

diff --git a/AUTHORS b/AUTHORS
new file mode 100644
index 0000000..99d233c
--- /dev/null
+++ b/AUTHORS
@@ -0,0 +1,4 @@
+SVGU Authors
+============
+
+* Nicolas "nc0" Paul <n@nc0.fr> (https://nc0.fr)
diff --git a/BUGS b/BUGS
new file mode 100644
index 0000000..01b549a
--- /dev/null
+++ b/BUGS
@@ -0,0 +1,9 @@
+SVGU issue tracking
+===================
+
+To report any bug or issue with the software, please open an entry on our
+issue tracker at https://github.com/nc0fr/svgu/issues.
+Make sure to give all necessary details.
+
+For security issues, please contact Nicolas Paul at Twitter (@nc0_fr) or via
+Email at <n@nc0.fr>.
diff --git a/README b/README
new file mode 100644
index 0000000..c5371a6
--- /dev/null
+++ b/README
@@ -0,0 +1,63 @@
+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
+---------------
+
+TODO
+
+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
+  
+  * 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.
diff --git a/README.md b/README.md
deleted file mode 100644
index ff7b188..0000000
--- a/README.md
+++ /dev/null
@@ -1,45 +0,0 @@
-# SVGU
-
-SVGU (short for *Static, Vanity, Go URL*) is a flexible and easy to use
-tool for creating vanity URLs for your Go projects.
-It allows publishing a Go module under a custom domain name, without the need
-to use your code forge's domain name.
-
-For example, if you have a project hosted on GitHub, you can use SVGU to
-publish it under a custom domain name, such as `myproject.com/foo` instead of
-`github.com/myproject/foo`.
-
-## How it works
-
-SVGU requires a configuration file, usually named `DOMAINS.star`, which
-describes the modules to export.
-
-The configuration file is a [Starlark](https://starlark.net) script, which
-allows for a lot of flexibility.
-Starlark is a subset of Python for configuration files, and is used by the
-[Bazel](https://bazel.build) build system and others.
-It is a simple language, and you don't need to know Python to use it.
-
-See the [reference documentation](doc/references.md) for more information.
-
-Once the configuration file is ready, you can run SVGU to generate the
-necessary files, and then publish them on your web server.
-
-```shell
-$ svgu
-```
-
-This will generate a `dst` directory containing the files to publish.
-
-## Documentation
-
-- [Getting started](doc/getting-started.md)
-- [Reference documentation](doc/references.md)
-- [Bug tracker](https://github.com/nseezero/svgu/issues)
-- [Source code](https://github.com/nseezero/svgu)
-
-## License
-
-The SVGU project is governed by a [BSD-style license](LICENSE).
-The documentation is licensed under the [Creative Commons Attribution 4.0
-International License](https://creativecommons.org/licenses/by/4.0/).