matrix-ipfs-bot

git clone git://archive.git.mtrnord.blog/MTRNord/matrix-ipfs-bot.git
Log | Files | Refs | LICENSE

Readme.md (4268B)

      1 <!-- PROJECT SHIELDS -->
      2 [![Contributors][contributors-shield]][contributors-url]
      3 [![Forks][forks-shield]][forks-url]
      4 [![Stargazers][stars-shield]][stars-url]
      5 [![Issues][issues-shield]][issues-url]
      6 [![GPL-3.0 License][license-shield]][license-url]
      7 <!--[![#daydream](https://img.shields.io/badge/matrix-%23daydream-blue?style=flat-square)](https://matrix.to/#/#daydream:nordgedanken.dev)-->
      8 
      9 
     10 
     11 <!-- PROJECT LOGO -->
     12 <br />
     13 <p align="center">
     14   <h3 align="center">Matrix IPFS Bot</h3>
     15 
     16   <p align="center">
     17     A bot for <a href="https://matrix.org">Matrix</a> that converts Matrix events using the <a href="https://github.com/matrix-org/matrix-rust-sdk/">Matrix Rust SDK</a> to IPFS Files
     18     <br />
     19     <br />
     20     <a href="https://github.com/MTRNord/matrix-ipfs-bot/issues">Report Bug</a>
     21     ·
     22     <a href="https://github.com/MTRNord/matrix-ipfs-bot/issues">Request Feature</a>
     23   </p>
     24 </p>
     25 
     26 
     27 
     28 <!-- TABLE OF CONTENTS -->
     29 ## Table of Contents
     30 
     31 * [About the Project](#about-the-project)
     32   * [Built With](#built-with)
     33 * [Getting Started](#getting-started)
     34   * [Prerequisites](#prerequisites)
     35   * [Setting up a Development Environment](#setting-up-a-development-environment)
     36 <!--* [Usage](#usage)-->
     37 * [Roadmap](#roadmap)
     38 * [Contributing](#contributing)
     39 * [License](#license)
     40 * [Contact](#contact)
     41 * [Acknowledgements](#acknowledgements)
     42 
     43 
     44 
     45 <!-- ABOUT THE PROJECT -->
     46 ## About The Project
     47 
     48 
     49 ### Built With
     50 
     51 * [Rust](https://www.rust-lang.org/)
     52 * [Matrix](https://matrix.org)
     53 * [Matrix Rust SDK](https://github.com/matrix-org/matrix-rust-sdk/)
     54 
     55 
     56 
     57 <!-- GETTING STARTED -->
     58 ## Getting Started
     59 
     60 To get a local copy up and running follow these simple steps.
     61 
     62 ## Best practice
     63 Make your upload ipfs gateway public and use it for links for best performance
     64 
     65 ### Prerequisites
     66 
     67 This is an example of how to list things you need to use the software and how to install them.
     68 * Rust
     69 * IPFS
     70 
     71 ### Setting up a Development Environment
     72  
     73 1. Clone the repo
     74 ```sh
     75 git clone https://github.com/MTRNord/Daydream.git
     76 ```
     77 
     78 2. Install the IPFS client from [ipfs.io](https://ipfs.io)
     79 
     80 #### 🛠️ Build
     81 
     82 ```sh
     83 cargo build
     84 ```
     85 
     86 #### 🔬 Run
     87 
     88 ```sh
     89 cargo run -- <homeserver_url> <username> <password>
     90 ```
     91 
     92 <!-- ROADMAP -->
     93 ## Roadmap
     94 
     95 See the [open issues](https://github.com/MTRNord/matrix-ipfs-bot/issues) for a list of proposed features (and known issues).
     96 
     97 
     98 
     99 <!-- CONTRIBUTING -->
    100 ## Contributing
    101 
    102 Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
    103 
    104 1. Fork the Project
    105 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
    106 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
    107 4. Push to the Branch (`git push origin feature/AmazingFeature`)
    108 5. Open a Pull Request
    109 
    110 
    111 
    112 <!-- LICENSE -->
    113 ## License
    114 
    115 Distributed under the AGPL-v3.0 License. See `LICENSE` for more information.
    116 
    117 
    118 
    119 <!-- CONTACT -->
    120 ## Contact
    121 
    122 <!--Matrix Room - [#daydream:nordgedanken.dev](https://matrix.to/#/#daydream:nordgedanken.dev)-->
    123 
    124 MTRNord - [@mtrnord](https://github.com/mtrnord) - https://matrix.to/#/@mtrnord:nordgedanken.dev
    125 
    126 Project Link: [https://github.com/MTRNord/matrix-ipfs-bot](https://github.com/MTRNord/matrix-ipfs-bot)
    127 
    128 
    129 
    130 <!-- ACKNOWLEDGEMENTS -->
    131 ## Acknowledgements
    132 
    133 
    134 
    135 
    136 
    137 <!-- MARKDOWN LINKS & IMAGES -->
    138 <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
    139 [contributors-shield]: https://img.shields.io/github/contributors/MTRNord/matrix-ipfs-bot.svg?style=flat-square
    140 [contributors-url]: https://github.com/MTRNord/matrix-ipfs-bot/graphs/contributors
    141 [forks-shield]: https://img.shields.io/github/forks/MTRNord/matrix-ipfs-bot.svg?style=flat-square
    142 [forks-url]: https://github.com/MTRNord/matrix-ipfs-bot/network/members
    143 [stars-shield]: https://img.shields.io/github/stars/MTRNord/matrix-ipfs-bot.svg?style=flat-square
    144 [stars-url]: https://github.com/MTRNord/matrix-ipfs-bot/stargazers
    145 [issues-shield]: https://img.shields.io/github/issues/MTRNord/matrix-ipfs-bot.svg?style=flat-square
    146 [issues-url]: https://github.com/MTRNord/matrix-ipfs-bot/issues
    147 [license-shield]: https://img.shields.io/github/license/MTRNord/matrix-ipfs-bot.svg?style=flat-square
    148 [license-url]: https://github.com/MTRNord/matrix-ipfs-bot/blob/master/LICENSE