From e88288ed561b9adb4fc35690fdb0bcde20b577d9 Mon Sep 17 00:00:00 2001 From: mikwee Date: Tue, 23 Nov 2021 14:10:03 +0200 Subject: [PATCH] Changed roots.json, Started writing readme --- README.md | 79 +++++++------------------------------------------- src/roots.json | 10 +++---- 2 files changed, 16 insertions(+), 73 deletions(-) diff --git a/README.md b/README.md index 02aac3f..36faf8d 100644 --- a/README.md +++ b/README.md @@ -1,70 +1,13 @@ -# Getting Started with Create React App +# LinkRoots +LinkRoots is a libre, lightweight, self-hosted alternative to Linktree. -This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). +## How to use it +1. Clone the repository. +2. Replace `background.png` with any background image of your choice. +3. Edit `roots.json` to modify the page. The example should be enough to help you understand the format, but feel free to ask me questions if you still don't get it! +4. Host it! -## Available Scripts - -In the project directory, you can run: - -### `yarn start` - -Runs the app in the development mode.\ -Open [http://localhost:3000](http://localhost:3000) to view it in the browser. - -The page will reload if you make edits.\ -You will also see any lint errors in the console. - -### `yarn test` - -Launches the test runner in the interactive watch mode.\ -See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information. - -### `yarn build` - -Builds the app for production to the `build` folder.\ -It correctly bundles React in production mode and optimizes the build for the best performance. - -The build is minified and the filenames include the hashes.\ -Your app is ready to be deployed! - -See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information. - -### `yarn eject` - -**Note: this is a one-way operation. Once you `eject`, you can’t go back!** - -If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project. - -Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own. - -You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it. - -## Learn More - -You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started). - -To learn React, check out the [React documentation](https://reactjs.org/). - -### Code Splitting - -This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting) - -### Analyzing the Bundle Size - -This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size) - -### Making a Progressive Web App - -This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app) - -### Advanced Configuration - -This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration) - -### Deployment - -This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment) - -### `yarn build` fails to minify - -This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify) +## Button types +| Type | | +|---|---| +| | | diff --git a/src/roots.json b/src/roots.json index d5d3406..8d7bc58 100644 --- a/src/roots.json +++ b/src/roots.json @@ -1,6 +1,11 @@ { "title": "LinkRoots Example", "links": [ + { + "type": "basic", + "url": "https://mikwee.tumblr.com", + "text": "Basic" + }, { "type": "facebook", "url": "https://facebook.com", @@ -45,11 +50,6 @@ "type": "reddit", "url": "https://reddit.com/u/mikwee", "text": "Reddit" - }, - { - "type": "basic", - "url": "https://mikwee.tumblr.com", - "text": "Basic" } ] } \ No newline at end of file