Spaces:
Running
Running
Justin
commited on
Commit
·
ea7a82a
1
Parent(s):
517f827
Update README.md
Browse files
README.md
CHANGED
|
@@ -7,4 +7,172 @@ sdk: static
|
|
| 7 |
pinned: false
|
| 8 |
---
|
| 9 |
|
| 10 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 7 |
pinned: false
|
| 8 |
---
|
| 9 |
|
| 10 |
+
WIP Profile
|
| 11 |
+
|
| 12 |
+
<!-- PROJECT LOGO -->
|
| 13 |
+
<br />
|
| 14 |
+
<div align="center">
|
| 15 |
+
<a href="https://github.com/othneildrew/Best-README-Template">
|
| 16 |
+
<img src="https://aimodelmanager.com/img/demo-screen-1.jpg" alt="Logo" width="638" height="435">
|
| 17 |
+
</a>
|
| 18 |
+
|
| 19 |
+
<h3 align="center">AI Model Manager</h3>
|
| 20 |
+
|
| 21 |
+
<p align="center">
|
| 22 |
+
AI Model Manager is an open source app that allows you to store your model files in one location.
|
| 23 |
+
</p>
|
| 24 |
+
</div>
|
| 25 |
+
|
| 26 |
+
<!-- TABLE OF CONTENTS -->
|
| 27 |
+
## Table of Contents
|
| 28 |
+
|
| 29 |
+
<summary>Table of Contents</summary>
|
| 30 |
+
<ol>
|
| 31 |
+
<li>
|
| 32 |
+
<a href="#about-the-project">About The Project</a>
|
| 33 |
+
<ul>
|
| 34 |
+
<li><a href="#built-with">Built With</a></li>
|
| 35 |
+
</ul>
|
| 36 |
+
</li>
|
| 37 |
+
<li>
|
| 38 |
+
<a href="#getting-started">Getting Started</a>
|
| 39 |
+
<ul>
|
| 40 |
+
<li><a href="#prerequisites">Prerequisites</a></li>
|
| 41 |
+
<li><a href="#installation">Installation</a></li>
|
| 42 |
+
</ul>
|
| 43 |
+
</li>
|
| 44 |
+
<li><a href="#usage">Usage</a></li>
|
| 45 |
+
<li><a href="#roadmap">Roadmap</a></li>
|
| 46 |
+
<li><a href="#contributing">Contributing</a></li>
|
| 47 |
+
<li><a href="#license">License</a></li>
|
| 48 |
+
<li><a href="#contact">Contact</a></li>
|
| 49 |
+
<li><a href="#acknowledgments">Acknowledgments</a></li>
|
| 50 |
+
</ol>
|
| 51 |
+
|
| 52 |
+
|
| 53 |
+
|
| 54 |
+
<!-- ABOUT THE PROJECT -->
|
| 55 |
+
## About The Project
|
| 56 |
+
|
| 57 |
+
### Built With
|
| 58 |
+
|
| 59 |
+
<p align="right">(<a href="#table-of-contents">back to top</a>)</p>
|
| 60 |
+
|
| 61 |
+
|
| 62 |
+
|
| 63 |
+
<!-- GETTING STARTED -->
|
| 64 |
+
## Getting Started
|
| 65 |
+
|
| 66 |
+
This is an example of how you may give instructions on setting up your project locally.
|
| 67 |
+
To get a local copy up and running follow these simple example steps.
|
| 68 |
+
|
| 69 |
+
### Prerequisites
|
| 70 |
+
|
| 71 |
+
This is an example of how to list things you need to use the software and how to install them.
|
| 72 |
+
* npm
|
| 73 |
+
```sh
|
| 74 |
+
npm install npm@latest -g
|
| 75 |
+
```
|
| 76 |
+
|
| 77 |
+
### Installation
|
| 78 |
+
|
| 79 |
+
_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._
|
| 80 |
+
|
| 81 |
+
1. Get a free API Key at [https://example.com](https://example.com)
|
| 82 |
+
2. Clone the repo
|
| 83 |
+
```sh
|
| 84 |
+
git clone https://github.com/your_username_/Project-Name.git
|
| 85 |
+
```
|
| 86 |
+
3. Install NPM packages
|
| 87 |
+
```sh
|
| 88 |
+
npm install
|
| 89 |
+
```
|
| 90 |
+
4. Enter your API in `config.js`
|
| 91 |
+
```js
|
| 92 |
+
const API_KEY = 'ENTER YOUR API';
|
| 93 |
+
```
|
| 94 |
+
|
| 95 |
+
<p align="right">(<a href="#table-of-contents">back to top</a>)</p>
|
| 96 |
+
|
| 97 |
+
|
| 98 |
+
|
| 99 |
+
<!-- USAGE EXAMPLES -->
|
| 100 |
+
## Usage
|
| 101 |
+
|
| 102 |
+
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
|
| 103 |
+
|
| 104 |
+
_For more examples, please refer to the [Documentation](https://example.com)_
|
| 105 |
+
|
| 106 |
+
<p align="right">(<a href="#table-of-contents">back to top</a>)</p>
|
| 107 |
+
|
| 108 |
+
|
| 109 |
+
|
| 110 |
+
<!-- ROADMAP -->
|
| 111 |
+
## Roadmap
|
| 112 |
+
|
| 113 |
+
- [x] Add Changelog
|
| 114 |
+
- [x] Add back to top links
|
| 115 |
+
- [ ] Add Additional Templates w/ Examples
|
| 116 |
+
- [ ] Add "components" document to easily copy & paste sections of the readme
|
| 117 |
+
- [ ] Multi-language Support
|
| 118 |
+
- [ ] Chinese
|
| 119 |
+
- [ ] Spanish
|
| 120 |
+
|
| 121 |
+
|
| 122 |
+
See the [open issues](https://github.com/othneildrew/Best-README-Template/issues) for a full list of proposed features (and known issues).
|
| 123 |
+
|
| 124 |
+
<p align="right">(<a href="#table-of-contents">back to top</a>)</p>
|
| 125 |
+
|
| 126 |
+
|
| 127 |
+
|
| 128 |
+
<!-- CONTRIBUTING -->
|
| 129 |
+
## Contributing
|
| 130 |
+
|
| 131 |
+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
|
| 132 |
+
|
| 133 |
+
<p align="right">(<a href="#table-of-contents">back to top</a>)</p>
|
| 134 |
+
|
| 135 |
+
|
| 136 |
+
|
| 137 |
+
<!-- LICENSE -->
|
| 138 |
+
## License
|
| 139 |
+
|
| 140 |
+
<p align="right">(<a href="#table-of-contentsp">back to top</a>)</p>
|
| 141 |
+
|
| 142 |
+
|
| 143 |
+
|
| 144 |
+
<!-- CONTACT -->
|
| 145 |
+
## Contact
|
| 146 |
+
|
| 147 |
+
<p align="right">(<a href="#table-of-contents">back to top</a>)</p>
|
| 148 |
+
|
| 149 |
+
|
| 150 |
+
|
| 151 |
+
<!-- ACKNOWLEDGMENTS -->
|
| 152 |
+
## Acknowledgments
|
| 153 |
+
|
| 154 |
+
[![Contributors][contributors-shield]][contributors-url]
|
| 155 |
+
[![Forks][forks-shield]][forks-url]
|
| 156 |
+
[![Stargazers][stars-shield]][stars-url]
|
| 157 |
+
[![Issues][issues-shield]][issues-url]
|
| 158 |
+
[![Apache License][license-shield]][license-url]
|
| 159 |
+
|
| 160 |
+
Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!
|
| 161 |
+
|
| 162 |
+
<p align="right">(<a href="#table-of-contents">back to top</a>)</p>
|
| 163 |
+
|
| 164 |
+
|
| 165 |
+
|
| 166 |
+
<!-- MARKDOWN LINKS & IMAGES -->
|
| 167 |
+
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
|
| 168 |
+
[contributors-shield]: https://img.shields.io/github/contributors/othneildrew/Best-README-Template.svg?style=for-the-badge
|
| 169 |
+
[contributors-url]: https://github.com/visioninit/ai-model-manager/graphs/contributors
|
| 170 |
+
[forks-shield]: https://img.shields.io/github/forks/othneildrew/Best-README-Template.svg?style=for-the-badge
|
| 171 |
+
[forks-url]: https://github.com/visioninit/ai-model-manager/network/members
|
| 172 |
+
[stars-shield]: https://img.shields.io/github/stars/othneildrew/Best-README-Template.svg?style=for-the-badge
|
| 173 |
+
[stars-url]: https://github.com/visioninit/ai-model-manager/stargazers
|
| 174 |
+
[issues-shield]: https://img.shields.io/github/issues/othneildrew/Best-README-Template.svg?style=for-the-badge
|
| 175 |
+
[issues-url]: https://github.com/visioninit/ai-model-manager/issues
|
| 176 |
+
[license-shield]: https://img.shields.io/github/license/othneildrew/Best-README-Template.svg?style=for-the-badge
|
| 177 |
+
[license-url]: https://github.com//visioninit/ai-model-manager/blob/master/LICENSE.txt
|
| 178 |
+
[product-screenshot]: images/screenshot.png
|