v2: add change log and docs (#41)

* add change log and docs

* add version to english docs

CHANGELOG.md

@@ -15,6 +15,30 @@ Security in case of vulnerabilities.
 
  -->
 
+## [2.0.0]
+
+This is the major change after 5 years of this project creation.
+
+I've decided to revamp completely the project using modern tech and implementing a few features some people asked a couple years ago.
+
+### What has changed?
+
+The main change here is now the project is complete type-safe thanks to [Prisma](https://prisma.io).
+
+Also, instead Rest API, I've decide to switch completely to GraphQL. This will makes the documentation and the ability to fetch data easier.
+
+### all changes
+
+- refactor everything to TypeScript;
+- re-done the data processing to fix data mistakes such as keeping strings with numbers;
+- remove APIDoc in favor of GraphQL api docs;
+- update docs;
+- switch from `npm` to `pnpm`;
+- use relational database (`SQLite`) instead local `json` files for storing data;
+- implement filter ability. Now for in a few endpoints you can pass `skip` and `take` ([see more here](https://www.prisma.io/docs/concepts/components/prisma-client/pagination#offset-pagination));
+- migrate to Node18;
+- use full ESM instead CJS;
+
 ## [1.0.1]
 
 - tag docker image with `v1`

README.md

@@ -2,15 +2,13 @@
 
 > Brazilian Table of Food Composition
 
-<p>
+![GraphQL Client](./documentation/images/graphql-client.png)
+
+<p align="center">
  <a href="https://github.com/raulfdm/taco-api/actions/workflows/app.yml">
    <img src="https://github.com/raulfdm/taco-api/actions/workflows/app.yml/badge.svg"
         alt="build status">
  </a>
- <a href="https://travis-ci.org/raulfdm/taco-api">
-   <img src="https://travis-ci.org/raulfdm/taco-api.svg?branch=master"
-        alt="build status">
- </a>
 </p>
 
 ## Docs

documentation/.vuepress/config.ts

@@ -5,6 +5,21 @@ export default defineUserConfig({
     repo: 'raulfdm/taco-api',
     locales: {
       '/': {
+        navbar: [
+          {
+            text: 'Versão',
+            children: [
+              {
+                text: 'Changelog',
+                link: 'https://github.com/raulfdm/taco-api/blob/main/CHANGELOG.md',
+              },
+              {
+                text: 'v1.0.0',
+                link: 'https://6447d8ec2c2ccb00085151ca--taco-api.netlify.app/',
+              },
+            ],
+          },
+        ],
         selectLanguageName: 'Português',
         toggleColorMode: 'Alternar modo escuro',
         openInNewWindow: 'Abrir em nova aba',
@@ -18,6 +33,21 @@ export default defineUserConfig({
         selectLanguageText: 'Idiomas',
       },
       '/en/': {
+        navbar: [
+          {
+            text: 'Version',
+            children: [
+              {
+                text: 'Changelog',
+                link: 'https://github.com/raulfdm/taco-api/blob/main/CHANGELOG.md',
+              },
+              {
+                text: 'v1.0.0',
+                link: 'https://6447d8ec2c2ccb00085151ca--taco-api.netlify.app/',
+              },
+            ],
+          },
+        ],
         selectLanguageName: 'English',
       },
     },