瀏覽代碼

Added cargo information and readme badges

Daniel Szabo 3 年之前
父節點
當前提交
ce8bd4dd02
共有 3 個文件被更改,包括 46 次插入3 次删除
  1. 11 1
      Cargo.toml
  2. 27 1
      README.MD
  3. 8 1
      templates/help.html

+ 11 - 1
Cargo.toml

@@ -1,7 +1,17 @@
 [package]
 name="microbin"
-version="1.0.0"
+version="1.0.2"
 edition="2021"
+authors = ["Daniel Szabo <daniel.szabo99@outlook.com>"]
+license = "BSD-3-Clause"
+description = "Simple, performant, configurable, entirely self-contained Pastebin and URL shortener."
+readme = "README.md"
+homepage = "https://github.com/szabodanika/microbin"
+repository = "https://github.com/szabodanika/microbin"
+keywords = ["pastebin", "pastabin", "microbin", "actix", "selfhosted"]
+categories = ["pastebins"]
+
+
 
 [dependencies]
 actix-web="4"

+ 27 - 1
README.MD

@@ -3,10 +3,22 @@
 
 # MicroBin
 
+
+![Build](https://github.com/szabodanika/microbin/actions/workflows/rust.yml/badge.svg)
+![crates.io](https://img.shields.io/crates/v/microbin.svg)
+
+
 MicroBin is a super tiny, feature rich, configurable, self-contained and self-hosted paste bin web application. It is very easy to set up and use, and will only require a few megabytes of memory and disk storage. It takes only a couple minutes to set it up, why not give it a try now?
 
 [![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/szabodanika/microbin)
+ 
+Or install from Cargo: 
 
+`cargo install microbin`
+
+And run with your custom configuration:
+
+`microbin --port 8080 --highlightsyntax --editable`
 
 ### Features
 - Is very small
@@ -81,6 +93,20 @@ or to download the pasta: `curl https://microbin.myserver.com/rawpasta/fish-pony
 
 ## 2 Installation
 
+### From Cargo
+
+Install from Cargo:
+
+`cargo install microbin`
+
+Remember, MicroBin will create your database and file storage wherever you execute it. I recommend that you create a folder for it first and execute it there:
+
+`mkdir ~/microbin/`
+
+`cd ~/microbin/`
+
+`microbin --port 8080 --highlightsyntax --editable`
+
 ### Building MicroBin
 
 Simply clone the repository, build it with `cargo build --release` and run the `microbin` executable in the created `target/release/` directory. It will start on port 8080. You can change the port with `-p` or `--port` CL arguments. For other arguments see [the Wiki](https://github.com/szabodanika/microbin/wiki).
@@ -94,7 +120,7 @@ cargo build --release
 
 ### MicroBin as a service
 
-To install it as a service on your Linux machine, create a file called `/etc/systemd/system/microbin.service`, paste this into it with the `[username]` and `[path to installation directory]` replaced with the actual values.
+To install it as a service on your Linux machine, create a file called `/etc/systemd/system/microbin.service`, paste this into it with the `[username]` and `[path to installation directory]` replaced with the actual values. If you installed MicroBin from cargo, your executable will be in your cargo directory, e.g. `/Users/daniel/.cargo/bin/microbin`.
 
 ```
 [Unit]

+ 8 - 1
templates/help.html

@@ -40,6 +40,13 @@
 <p>Use cURL to read the pasta: <code>curl https://microbin.myserver.com/rawpasta/fish-pony-crow</code>,</p>
 <p>or to download the pasta: <code>curl https://microbin.myserver.com/rawpasta/fish-pony-crow &gt; output.txt</code> (use /file instead of /rawpasta to download attached file).</p>
 <h2 id="2-installation">2 Installation</h2>
+<h3 id="from-cargo">From Cargo</h3>
+<p>Install from Cargo:</p>
+<p><code>cargo install microbin</code></p>
+<p>Remember, MicroBin will create your database and file storage wherever you execute it. I recommend that you create a folder for it first and execute it there:</p>
+<p><code>mkdir ~/microbin/</code></p>
+<p><code>cd ~/microbin/</code></p>
+<p><code>microbin --port 8080 --highlightsyntax --editable</code></p>
 <h3 id="building-microbin">Building MicroBin</h3>
 <p>Simply clone the repository, build it with <code>cargo build --release</code> and run the <code>microbin</code> executable in the created <code>target/release/</code> directory. It will start on port 8080. You can change the port with <code>-p</code> or <code>--port</code> CL arguments. For other arguments see <a href="https://github.com/szabodanika/microbin/wiki">the Wiki</a>.</p>
 <pre><code>git clone https:<span class="hljs-comment">//github.com/szabodanika/microbin.git</span>
@@ -47,7 +54,7 @@ cd microbin
 cargo build --<span class="hljs-built_in">release</span>
 ./target/<span class="hljs-built_in">release</span>/microbin -p <span class="hljs-number">80</span>
 </code></pre><h3 id="microbin-as-a-service">MicroBin as a service</h3>
-<p>To install it as a service on your Linux machine, create a file called <code>/etc/systemd/system/microbin.service</code>, paste this into it with the <code>[username]</code> and <code>[path to installation directory]</code> replaced with the actual values.</p>
+<p>To install it as a service on your Linux machine, create a file called <code>/etc/systemd/system/microbin.service</code>, paste this into it with the <code>[username]</code> and <code>[path to installation directory]</code> replaced with the actual values. If you installed MicroBin from Cargo, your executable will be in your system's Cargo directory, e.g. <code>/Users/daniel/.cargo/bin/microbin</code>.</p>
 <pre><code><span class="hljs-section">[Unit]</span>
 <span class="hljs-attr">Description</span>=MicroBin
 <span class="hljs-attr">After</span>=network.target