From 3d17619834fe3599cc0d6eb8afbe08793f756d77 Mon Sep 17 00:00:00 2001 From: Pratik Panda Date: Fri, 9 Jun 2023 22:34:21 -0700 Subject: [PATCH 1/2] Update README with quickstart guide --- README.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 54e04c1..89c066f 100644 --- a/README.md +++ b/README.md @@ -7,4 +7,25 @@ Tafkars stands for "The API formerly known as...", is written in Rust and is pro ## Help wanted -There is still lots of work to be done, especially on [`tafkars-lemmy`](tafkars-lemmy). Pull requests welcome! \ No newline at end of file +There is still lots of work to be done, especially on [`tafkars-lemmy`](tafkars-lemmy). Pull requests welcome! + +## Quickstart Guide + +This Quickstart guide assumes you are using [this fork of libreddit](https://github.com/derivator/libreddit) and [lemmy.world](lemmy.world) to quickly get up and running with tafkars. + +- Run tafkars: + - You can substitute lemmy.ml with any lemmy instance of your choice +``` +git clone https://github.com/derivator/tafkars +cd tafkars +cargo run lemmy.world +``` +- Run libreddit app against `127.0.0.1:8000` (default location of tafkars API): + - You can substitute this with any app that allows for a custom API URL to be passed in +``` +git clone https://github.com/derivator/libreddit +cd libreddit +cargo run +``` +- Visit webclient for libreddit: [http://localhost:8080/](http://localhost:8080/) + - You can substitute this with whatever app you are using. \ No newline at end of file From 8c6b449dadee6bc74c411ad41208934df491c79f Mon Sep 17 00:00:00 2001 From: Pratik Panda Date: Wed, 14 Jun 2023 19:48:55 -0700 Subject: [PATCH 2/2] Updated README with feedback --- README.md | 23 +---------------------- tafkars-lemmy/README.md | 23 +++++++++++++++++++++++ 2 files changed, 24 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 89c066f..54e04c1 100644 --- a/README.md +++ b/README.md @@ -7,25 +7,4 @@ Tafkars stands for "The API formerly known as...", is written in Rust and is pro ## Help wanted -There is still lots of work to be done, especially on [`tafkars-lemmy`](tafkars-lemmy). Pull requests welcome! - -## Quickstart Guide - -This Quickstart guide assumes you are using [this fork of libreddit](https://github.com/derivator/libreddit) and [lemmy.world](lemmy.world) to quickly get up and running with tafkars. - -- Run tafkars: - - You can substitute lemmy.ml with any lemmy instance of your choice -``` -git clone https://github.com/derivator/tafkars -cd tafkars -cargo run lemmy.world -``` -- Run libreddit app against `127.0.0.1:8000` (default location of tafkars API): - - You can substitute this with any app that allows for a custom API URL to be passed in -``` -git clone https://github.com/derivator/libreddit -cd libreddit -cargo run -``` -- Visit webclient for libreddit: [http://localhost:8080/](http://localhost:8080/) - - You can substitute this with whatever app you are using. \ No newline at end of file +There is still lots of work to be done, especially on [`tafkars-lemmy`](tafkars-lemmy). Pull requests welcome! \ No newline at end of file diff --git a/tafkars-lemmy/README.md b/tafkars-lemmy/README.md index 822166f..e0db7a5 100644 --- a/tafkars-lemmy/README.md +++ b/tafkars-lemmy/README.md @@ -4,6 +4,29 @@ Tafkars stands for "The API formerly known as...", is written in Rust and is pro `tafkars-lemmy` is an API proxy that allows apps to talk to [Lemmy](https://github.com/LemmyNet/lemmy) through a familiar API from a kinder time. The hope is that this will make it easy for app developers to support Lemmy with only minimal code changes. +## Quickstart Guide + +This Quickstart guide assumes you are using [this fork of libreddit](https://github.com/derivator/libreddit) and [lemmy.world](https://lemmy.world) to quickly get up and running with tafkars. +`tafkars-lemmy` should work with any Reddit client that allows you to set the API url. In this guide, we will use a [fork of libreddit](https://github.com/derivator/libreddit) for quick setup. +`tafkars-lemmy` should work with any Lemmy instance. In this guide, we will use [lemmy.world](https://lemmy.world) for quick setup. + +- Run tafkars: + - You can substitute lemmy.world with any lemmy instance of your choice +``` +git clone https://github.com/derivator/tafkars +cd tafkars +cargo run https://lemmy.world +``` +- Run libreddit app against `127.0.0.1:8000` (default location of tafkars-lemmy proxy): + - You can substitute this with any app that allows for a custom API URL to be passed in +``` +git clone https://github.com/derivator/libreddit +cd libreddit +cargo run +``` +- Visit webclient for libreddit: [http://localhost:8080/](http://localhost:8080/) + - You can substitute this with whatever app you are using. + ## API implementation status - [ ] viewing: