diff --git a/README.md b/README.md index 813ed8b..4ce8a19 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@

- Store and retrieve files on the ATmosphere (like Bluesky or Tangled)
+ Store and retrieve files on the Atmosphere (like Bluesky or Tangled)
Written entirely in Bash Shell. No NodeJS here!

@@ -44,11 +44,11 @@ atfile help * `sed` * Only GNU version supported * [`websocat`](https://github.com/vi/websocat) _(optional: needed for `stream`)_ -* **ATProto account** - * Limit the amount of files you upload, and avoid copyrighted files, if using a managed PDS
(e.g. [Blacksky](https://pds.blacksky.app), [Bluesky](https://bsky.social), [Spark](https://pds.sprk.so), [Tangled](https://tngl.sh), or any other independent PDS you don't own) - * Supports accounts with `did:plc` and `did:web` identities - * Supports PDSs running [Bluesky PDS](https://github.com/bluesky-social/pds) and [millipds](https://github.com/DavidBuchanan314/millipds) - * Other PDSs remain untested, but if they implement standard `com.atproto.*` endpoints, there should be no reason these won't work +* **Atproto account** + * Limit the amount of files you upload, and avoid copyrighted files, if using a managed PDS you don't own yourself + * Supports accounts with `did:plc` or `did:web` identities + * Supports PDSs running [Bluesky PDS](https://github.com/bluesky-social/pds) + * Other PDSs remain untested, but if they implement standard `com.atproto.*` endpoints and blob storage, there should be no reason these won't work * Filesize limits cannot be automatically detected. By default, this is 100MB * To change this on Bluesky PDS, set `PDS_BLOB_UPLOAD_LIMIT=` * If the PDS is running behind Cloudflare, the Free plan imposes a 100MB upload limit @@ -91,7 +91,7 @@ If you've pulled this repository, you can also use ATFile by simply calling `./a Config locations are identical to those above (see **Automatic ("`curl|bash`")** above). -**Using a development version against your ATProto account could potentially inadvertently damage records.** +**Using a development version against your Atproto account could potentially inadvertently damage records.** ### ⌨️ Using @@ -108,7 +108,7 @@ Various environment variables can be exported to control various aspects of the * `ATFILE_DEVEL_DIST_USERNAME` <string>
_(Todo)_. During runtime, this is set to `$did` in `atfile.sh` (see **🏗️ Building ➔ Meta**). Ideally, you should not set this variable as updates in the built version will not be fetched from the correct place * `ATFILE_DEVEL_DIST_PASSWORD` <string>
_(Todo)_ * `ATFILE_DEVEL_ENABLE_PIPING` <int> (default: `0`)
Allow piping (useful to test installation) _(e.g. `cat ./atfile.sh | bash`)_ -* `ATFILE_DEVEL_ENABLE_PUBLISH` <int> (default: `0`)
Publish build to ATProto repository (to allow for updating) as the last step when running `build`. Several requirements must be fulfilled: +* `ATFILE_DEVEL_ENABLE_PUBLISH` <int> (default: `0`)
Publish build to Atproto repository (to allow for updating) as the last step when running `build`. Several requirements must be fulfilled: * `ATFILE_DEVEL_DIST_USERNAME` must be set * `ATFILE_DEVEL_DIST_PASSWORD` must be set * No tests should return an **Error** (**Warning** is acceptable) @@ -134,7 +134,7 @@ Various meta variables can be set to be available in the final compiled build (u ## ⌨️ Contributing -Development takes place on [Tangled (@zio.sh/atfile)](https://tangled.sh/@zio.sh/atfile), with [GitHub (ziodotsh/atfile)](https://github.com/ziodotsh/atfile) acting as a mirror. Use Tangled for your contributions, for both Issues and Pulls. As Tangled is powered by ATProto, you already have an account (unsure? Try logging in with your Bluesky handle). +Development takes place on [Tangled (@zio.sh/atfile)](https://tangled.sh/@zio.sh/atfile), with [GitHub (ziodotsh/atfile)](https://github.com/ziodotsh/atfile) acting as a mirror. Use Tangled for your contributions, for both Issues and Pulls. As Tangled is powered by Atproto, you already have an account (unsure? Try logging in with your Bluesky handle). When submitting Pulls, **target the `dev` branch**: `main` is the current stable production version, and Pulls will be rejected targeting this branch. diff --git a/atfile.sh b/atfile.sh index bb0ef8d..527d008 100755 --- a/atfile.sh +++ b/atfile.sh @@ -12,7 +12,7 @@ # # Unless you're wanting to tinker, its recommended you install a stable version # of ATFile: see README for more. Using a development version against your -# ATProto account could potentially inadvertently damage records. +# Atproto account could potentially inadvertently damage records. # # Just as a published build, ATFile can be used entirely via this file. The # below code automatically sources everything for you, and your config (if diff --git a/src/commands/help.sh b/src/commands/help.sh index de86a52..19b07d0 100644 --- a/src/commands/help.sh +++ b/src/commands/help.sh @@ -22,7 +22,7 @@ function atfile.help() { usage_commands="Commands upload [] Upload new file to the PDS - ⚠️ ATProto records are public: do not upload sensitive files\n + ⚠️ Atproto records are public: do not upload sensitive files\n list [] [] list [] List all uploaded files. Only $_max_list items can be displayed; to @@ -183,11 +183,11 @@ function atfile.help() { usage="ATFile" [[ $_os != "haiku" ]] && usage+=" | 📦 ➔ 🦋" - usage+="\n Store and retrieve files on the ATmosphere\n + usage+="\n Store and retrieve files on the Atmosphere\n Version $_version (c) $_meta_year $_meta_author <$_meta_repo> Licensed as MIT License ✨\n - 🦋 Follow @$handle on the ATmosphere + 🦋 Follow @$handle on the Atmosphere ↳ $_endpoint_social_app_name: $_endpoint_social_app/profile/$handle ↳ Tangled: https://tangled.sh/@$handle