Skip to content

Commit

Permalink
adapt docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lukasbach committed Apr 8, 2022
1 parent 871f94c commit 71ebb9a
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 38 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Synergies

> Create a performant distributed context state by synergyzing atomar
> context pieces and composing reusable state logic.
> Create a performant distributed context state for React and compose reusable state logic.
![Testing](https://github.com/lukasbach/synergies/workflows/Testing/badge.svg)
![Pretty](https://github.com/lukasbach/synergies/workflows/Pretty/badge.svg)
Expand Down
38 changes: 2 additions & 36 deletions packages/docs/src/components/home/home.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -130,8 +130,6 @@ const Ctas = () => (
);

export const Home: React.FC<{}> = props => {
const { siteConfig } = useDocusaurusContext();
console.log(siteConfig);
useHideBars();
return (
<Layout
Expand Down Expand Up @@ -164,10 +162,8 @@ export const Home: React.FC<{}> = props => {
<span className={styles.yellow}>
performant distributed context state
</span>{" "}
by <span className={styles.red}>synergizing</span> atomar context
pieces and{" "}
<span className={styles.green}>composing reusable state logic</span>
.
for <span className={styles.red}>React</span> and compose{" "}
<span className={styles.green}>reusable state logic</span>.
</div>
<div className={clsx()}>
<Code code={introCode} />
Expand All @@ -186,36 +182,6 @@ export const Home: React.FC<{}> = props => {
<VisAppComponents className={styles.vis} />
</div>

<div className={clsx(styles.highlight, styles.statement, styles.right)}>
First there was <Red>Flux</Red>. Than there was{" "}
<Purple>Context</Purple>. Now there is <Green>Synergies</Green>.
</div>

<p className={clsx(styles.text)}>
In the past, Flux-like libraries were the goto for state management.
With React{"'"}s revamp of context, storing localized reusable state
in custom context providers became more common. You don{"'"}t need to
define the complete state in one place, you can reuse pieces of state,
and compose them however you want. But there remain issues...
</p>

<div className={clsx(styles.highlight, styles.statement, styles.left)}>
Lots of <Yellow>boilerplate</Yellow>. Nontrivial{" "}
<Red>performance</Red> optimization. Messy data{" "}
<Purple>exchange between contexts</Purple>.
</div>

<p className={clsx(styles.text)}>
Synergies{" "}
<b>
<Green>solves those issues</Green>
</b>{" "}
by streamlining the way how global and local context-based state is
defined and managed, provides clear and concise logic for deciding
which component should rerender and which should not, and makes
exchange between substates super easy!
</p>

<div
className={clsx(
styles.highlight,
Expand Down

0 comments on commit 71ebb9a

Please sign in to comment.