27 lines
1.3 KiB
Markdown
27 lines
1.3 KiB
Markdown
# SPARC
|
|
|
|
## Name
|
|
Semiconductor Patent & Analytics Report Core
|
|
|
|
## Description
|
|
|
|
## Installation
|
|
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
|
|
|
## Usage
|
|
```bash
|
|
docker compose up -d
|
|
```
|
|
|
|
## Roadmap
|
|
- [ ] Retrive `publicationID` from SERP API
|
|
- [ ] Retrive data from Google's patent API based on those `publicationID`'s
|
|
- [ ] Wrap this into a python fastAPI, then bundle with docker
|
|
|
|
|
|
## License
|
|
For open source projects, say how it is licensed.
|
|
|
|
## Project status
|
|
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|