commit fe189269b9bc3290fb39575cad50c788e33a1304
parent 2a895dff1ab02e0b0c6ef4238a936625506fb52a
Author: William Casarin <jb55@jb55.com>
Date: Sun, 17 Mar 2024 12:41:02 +0000
switch to damus data dump
Signed-off-by: William Casarin <jb55@jb55.com>
Diffstat:
| M | README.md | | | 79 | +++++++++---------------------------------------------------------------------- |
1 file changed, 9 insertions(+), 70 deletions(-)
diff --git a/README.md b/README.md
@@ -1,76 +1,15 @@
-<h3 align="center">Import and export GitHub issues via JSON</h3>
-</div>
-<p align="center">
-
- <a href="https://github.com/gavinr/github-csv-tools/actions?query=workflow%3ATest+branch%3Amaster">
- <img alt="Build" src="https://github.com/gavinr/github-csv-tools/workflows/Test/badge.svg">
- </a>
- <a href="https://github.com/gavinr/github-csv-tools/actions?query=workflow%3ARelease+branch%3Amaster">
- <img alt="Release" src="https://github.com/gavinr/github-csv-tools/workflows/Release/badge.svg">
- </a>
- <a href="https://www.npmjs.com/package/github-csv-tools">
- <img alt="npm latest version" src="https://img.shields.io/npm/v/github-csv-tools/latest.svg">
- </a>
- <a href="https://repoio.com">
- <img alt="npm latest version" src="https://img.shields.io/badge/hosted-repoio.com-orange">
- </a>
-</p>
+# Damus Github Data Export
-## Usage
+This repo contains tools and historic data dump of our github issue data. The
+goal is eventually to have this data stored on nostr instead.
-```bash
-node index.js -t github_token -o organization -r repository
-```
+## Files
-| Option | Default | Notes |
-| ---------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| -f, --exportFileName | YYYY-MM-DD-hh-mm-ss-issues.csv | The name of the CSV you'd like to export to. |
-| -a, --exportAttributes | number, title, labels, state, assignees, milestone, comments, created_at, updated_at, closed_at, body | Comma-separated list of attributes (columns) in the export**. |
-| -c, --exportComments | n/a | Include comments in the export. If using in combination with `--exportAttributes`, `id` must be included. |
-| -e, --exportAll | n/a | Export all possible values from the GitHub API. If not included, a subset of attributes (see `--exportAttributes` above) that are known to be compatible with GitHub *import* will be included in the export. |
+* damus.json: damus iOS issue dump
+* android.json: damus android issue dump
+* notedeck.json: damus notedeck issue dump
-** List of all possible options for `exportAttributes` includes every option in the [GitHub API Export](https://developer.github.com/v3/issues/#response-4). Values in child objects can be referenced using a "dot" - for example, a user's `avatar_url` can be accessed via `user.avatar_url`.
+## TODO
-### Tokens
-
-For all actions, the tool will ask you to input a GitHub token. To obtain this token:
-
-1. Go to <https://github.com/settings/tokens>
-2. Click "Generate New Token"
-3. Check on `repo`
-4. Copy/paste the token provided when the tool asks for it.
-
-## Other Options
-
-| Option | Notes |
-| ----------------------- | ------------------------------------------------------------------------------|
-| -V, --version | Output the version number |
-| -g, --github_enterprise | Your GitHub Enterprise URL. <https://your-internal-githubenterprise.com/api/v3> <br />(Reminder: do not forget the `/api/v3` at the end)|
-| -t, --token | The GitHub token. <https://github.com/settings/tokens> |
-| -o, --organization | The User or Organization slug that the repo lives under. <br />Example: For `/myOrg/my-repo`, this value would be **myOrg**. |
-| -r, --repository | The repository name (slug).<br />Example: For `/myOrg/my-repo`, this value would be **my-repo**. |
-| --csvDelimiter | The CSV delimiter character (defaults to ',') |
-| -v, --verbose | Include additional logging information. |
-| -h, --help | See all the options and help. |
-
-## Development
-
-1. Clone the repo.
-2. Browse to repo, then run `npm install -g`
-
-## Changelog
-
-See [CHANGELOG.md](https://github.com/gavinr/github-csv-tools/blob/master/CHANGELOG.md)
-
-## Hosted version [](https://repoio.com)
-
-This software can be used without download/install by going to [repoio.com](https://repoio.com).
-
-## Thanks
-
-- [octokit/rest.js](https://octokit.github.io/rest.js/)
-- [nodeCSV](https://www.npmjs.com/package/csv)
-- [commander](https://www.npmjs.com/package/commander)
-- [co](https://www.npmjs.com/package/co)
-- [Tim Patterson's Post on Atlassian.com](https://developer.atlassian.com/blog/2015/11/scripting-with-node/)
+We still need to dump our project data somehow (sprints, etc)
