docs: updated documentation about possible not needing google patent API
This commit is contained in:
parent
5fa5588571
commit
607cc9e1d5
2
.gitignore
vendored
2
.gitignore
vendored
@ -2,4 +2,4 @@
|
|||||||
.pyenv
|
.pyenv
|
||||||
__pycache__
|
__pycache__
|
||||||
.venv
|
.venv
|
||||||
patents/
|
patents
|
||||||
@ -6,7 +6,8 @@ Semiconductor Patent & Analytics Report Core
|
|||||||
## Description
|
## Description
|
||||||
|
|
||||||
## Installation
|
## 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.
|
### NixOS Installation
|
||||||
|
`nix develop` to build and configure nix dev environment
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
```bash
|
```bash
|
||||||
@ -14,8 +15,9 @@ docker compose up -d
|
|||||||
```
|
```
|
||||||
|
|
||||||
## Roadmap
|
## Roadmap
|
||||||
- [ ] Retrive `publicationID` from SERP API
|
- [X] Retrive `publicationID` from SERP API
|
||||||
- [ ] Retrive data from Google's patent API based on those `publicationID`'s
|
- [ ] Retrive data from Google's patent API based on those `publicationID`'s
|
||||||
|
- This may not be needed, looking to parse the patents based soley on the pdf retrived from SERP
|
||||||
- [ ] Wrap this into a python fastAPI, then bundle with docker
|
- [ ] Wrap this into a python fastAPI, then bundle with docker
|
||||||
|
|
||||||
|
|
||||||
@ -23,4 +25,4 @@ docker compose up -d
|
|||||||
For open source projects, say how it is licensed.
|
For open source projects, say how it is licensed.
|
||||||
|
|
||||||
## Project status
|
## 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.
|
Heavy development for the limited time available to me
|
||||||
Loading…
Reference in New Issue
Block a user